- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Operation Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- Introduction
- API Category
- Making API Requests
- Redis related APIs
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- FAQs
- Service Level Agreement
- Glossary
- Contact Us
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Operation Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- Introduction
- API Category
- Making API Requests
- Redis related APIs
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- FAQs
- Service Level Agreement
- Glossary
- Contact Us
1. API Description
Domain name for API request: dbbrain.intl.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.
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: 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 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. |
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 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. |
4. Example
Example1 Obtaining the space statistics of top databases
Input Example
https://dbbrain.intl.tencentcloudapi.com/?Action=DescribeTopSpaceSchemas
&InstanceId=cdb-test
&Limit=2
&SortBy=TableRows
&<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
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
Yes
No
Was this page helpful?