Domain name for API request: cdb.tencentcloudapi.com.
This API is used to query the statistics of backups. It will return the capacity used by backups at the instance level and the number and used capacity of data backups and log backups of each instance (all capacity values are in bytes).
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: cdb.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: DescribeBackupSummaries. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common parameter. 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. |
| Offset | No | Integer | Pagination offset. |
| Limit | No | Integer | Paginated query limit. Default value: 20. |
| OrderBy | No | String | Sorting criterion. Valid values: BackupVolume (backup capacity), DataBackupVolume (data backup capacity), BinlogBackupVolume (log backup capacity), AutoBackupVolume (automatic backup capacity), ManualBackupVolume (manual backup capacity). |
| OrderDirection | No | String | Sorting order. Valid values: ASC (ascending), DESC (descending). |
| Parameter Name | Type | Description |
|---|---|---|
| Items | Array of BackupSummaryItem | Statistical items of instance backup. |
| TotalCount | Integer | Total number of instance backups. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdb.tencentcloudapi.com/?Action=DescribeBackupSummaries
&Product=mysql
&Limit=1
&<Common request parameters>{
"Response": {
"Items": [
{
"AutoBackupCount": 5,
"AutoBackupVolume": 10000,
"BackupVolume": 50000,
"BinlogBackupCount": 2,
"BinlogBackupVolume": 20000,
"DataBackupCount": 15,
"DataBackupVolume": 30000,
"InstanceId": "cdb-01wa5l0v",
"ManualBackupCount": 10,
"ManualBackupVolume": 20000
}
],
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 50
}
}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 |
|---|---|
| InternalError.CdbError | System error. |
| InvalidParameter | Parameter error. |
Was this page helpful?