1. API Description
Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the data backup overview of a user in the current region.
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.
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: DescribeDataBackupOverview. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2017-03-20. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| Product |
Yes |
String |
TencentDB product type to be queried. Currently, only mysql is supported. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| DataBackupVolume |
Integer |
Total capacity of data backups in bytes in the current region (including automatic backups and manual backups). |
| DataBackupCount |
Integer |
Total number of data backups in the current region. |
| AutoBackupVolume |
Integer |
Total capacity of automatic backups in the current region. |
| AutoBackupCount |
Integer |
Total number of automatic backups in the current region. |
| ManualBackupVolume |
Integer |
Total capacity of manual backups in the current region. |
| ManualBackupCount |
Integer |
Total number of manual backups in the current region. |
| RemoteBackupVolume |
Integer |
Total capacity of remote backups |
| RemoteBackupCount |
Integer |
Total number of remote backups |
| DataBackupArchiveVolume |
Integer |
Total capacity of archive backups in the current region |
| DataBackupArchiveCount |
Integer |
Total number of archive backups in the current region |
| DataBackupStandbyVolume |
Integer |
Total backup capacity of standard storage in current region |
| DataBackupStandbyCount |
Integer |
Total number of standard storage backups in current region |
| 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 DescribeDataBackupOverview
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataBackupOverview
<Common request parameters>
{
"Product": "mysql"
}
Output Example
{
"Response": {
"AutoBackupCount": 3,
"AutoBackupVolume": 3000,
"DataBackupCount": 5,
"DataBackupVolume": 5000,
"ManualBackupCount": 2,
"ManualBackupVolume": 2000,
"RemoteBackupVolume": 1000,
"RemoteBackupCount": 1,
"DataBackupArchiveVolume": 1000,
"DataBackupArchiveCount": 1,
"DataBackupStandbyVolume": 1000,
"DataBackupStandbyCount": 1,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
5. Developer Resources
SDK
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.SubAccountDenied |
The sub-account has no permissions. |
| InternalError.CdbError |
System error. |
| InvalidParameter.ControllerNotFoundError |
This API was not found. |
| InvalidParameterValue.InvalidParameterValueError |
Invalid parameter value |