Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to query real-time space statistics of top databases. The return results are sorted by size by default.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dbbrain.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeTopSpaceSchemas. |
Version | Yes | String | Common parameter. The value used for this API: 2019-10-16. |
Region | Yes | String | Common parameter. 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 databases. 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 (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 (TencentDB for CynosDB (compatible with MySQL)). Default value: mysql . |
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 collect points |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dbbrain.tencentcloudapi.com/?Action=DescribeTopSpaceSchemas
&InstanceId=cdb-test
&Limit=2
&SortBy=TableRows
&<common request parameters>
{
"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
}
]
}
}
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 |
---|---|
AuthFailure | Error with CAM signature/authentication. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
OperationDenied | Operation denied. |
OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
Was this page helpful?