tencent cloud



Last updated: 2023-04-12 15:42:46

1. API Description

Domain name for API request: dbbrain.tencentcloudapi.com.

This API is used to get the real-time space statistics of top databases of an instance. The returned results are sorted by size by default.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTopSpaceSchemas.
Version Yes String Common Params. The value used for this API: 2021-05-27.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID.
Limit No Integer Number of returned top databases. Maximum value: 100. Default value: 20.
SortBy No String Field used to sort top databases. Valid values: DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, PhysicalFileSize (supported only by TencentDB for MySQL instances). For TencentDB for MySQL instances, the default value is PhysicalFileSize. For other database instances, the default value is TotalLength.
Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

3. Output Parameters

Parameter Name Type Description
TopSpaceSchemas Array of SchemaSpaceData List of the returned space statistics of top databases.
Timestamp Integer Timestamp (in seconds) of database space data collection points
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining space statistics of top databases

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
        "Timestamp": 1603819881,
        "TopSpaceSchemas": [
                "DataFree": 0,
                "TotalLength": 0.1,
                "TableSchema": "test_bak",
                "FragRatio": 0,
                "DataLength": 0.1,
                "PhysicalFileSize": 0.1,
                "TableRows": 9,
                "IndexLength": 0
                "DataFree": 0,
                "TotalLength": 0.1,
                "TableSchema": "test_bak",
                "FragRatio": 0,
                "DataLength": 0.1,
                "PhysicalFileSize": 0.1,
                "TableRows": 9,
                "IndexLength": 0

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support