Domain name for API request: cdb.intl.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.
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: DescribeBackupSummaries. |
| 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. |
| Offset | No | Integer | Paginated query offset. Default value: 0. |
| Limit | No | Integer | Maximum entries returned per page, which ranges from 1 to 100. 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). Default value: BackupVolume. |
| OrderDirection | No | String | Sorting order. Valid values: ASC (ascending), DESC (descending). Default value: ASC. |
| 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, 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. |
This example shows you how to query the real-time backup statistics.
POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBackupSummaries<Common request parameters>{ "Product": "mysql", "Limit": "1"}{
"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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| AuthFailure.SubAccountDenied | The sub-account has no permissions. |
| InternalError.CdbError | System error. |
| InternalError.DBError | Database exception |
| InvalidParameter | Parameter error. |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
| OperationDenied.SubAccountOperationDenied | The Tencent Cloud sub-account is not allowed to perform the operation due to insufficient permissions. |
피드백