Domain name for API request: dbbrain.intl.tencentcloudapi.com.
This API is used to query real-time space statistics of top tables of an instance. The return results are sorted by size by default.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeTopSpaceTables. |
Version | Yes | String | Common Params. The value used for this API: 2019-10-16. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID. |
Limit | No | Integer | Number of returned top tables. Maximum value: 100. Default value: 20. |
SortBy | No | String | Field used to sort top tables. Valid values: DataLength , IndexLength , TotalLength , DataFree , FragRatio , TableRows , and PhysicalFileSize (only supported 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 (TencentDB for CynosDB (compatible with MySQL)). Default value: mysql . |
Parameter Name | Type | Description |
---|---|---|
TopSpaceTables | Array of TableSpaceData | List of the returned space statistics of top tables. |
Timestamp | Integer | Timestamp (in seconds) of tablespace data collect points |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://dbbrain.intl.tencentcloudapi.com/?Action=DescribeTopSpaceTables
&InstanceId=cdb-test
&Limit=2
&SortBy=TableRows
&<common request parameters>
{
"Response": {
"RequestId": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
"Timestamp": 1603819881,
"TopSpaceTables": [
{
"DataFree": 0,
"TableName": "test",
"TotalLength": 0.1,
"TableSchema": "test_bak",
"FragRatio": 0,
"DataLength": 0.1,
"PhysicalFileSize": 0.1,
"TableRows": 9,
"Engine": "InnoDB",
"IndexLength": 0
},
{
"DataFree": 0,
"TableName": "test",
"TotalLength": 0.1,
"TableSchema": "test_bak",
"FragRatio": 0,
"DataLength": 0.1,
"PhysicalFileSize": 0.1,
"TableRows": 9,
"Engine": "InnoDB",
"IndexLength": 0
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
UnauthorizedOperation | The operation is unauthorized. |
Was this page helpful?