Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the backup overview of a user. It will return the user's current total number of backups, total capacity used by backups, capacity in the free tier, and paid capacity (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: DescribeBackupOverview. |
| 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 | The cloud database product type for which a backup overview needs to be queried. The value can be mysql (two-node/three-node high-availability instances), mysql-basic (single-node cloud disk edition instance), or mysql-cluster (cloud disk edition instance). |
| Parameter Name | Type | Description |
|---|---|---|
| BackupCount | Integer | Total number of backups of a user in the current region (including data backups and log backups). |
| BackupVolume | Integer | Total capacity of backups of a user in the current region. |
| BillingVolume | Integer | Paid capacity of backups of a user in the current region, i.e., capacity that exceeds the free tier. |
| FreeVolume | Integer | Backup capacity in the free tier of a user in the current region. |
| RemoteBackupVolume | Integer | Total offsite backup capacity of the user in current region. |
| BackupArchiveVolume | Integer | Archive backup capacity, including data backup and log backup. |
| BackupStandbyVolume | Integer | Standard storage backup capacity includes data backup and log backup. |
| 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. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupOverview
<Common request parameters>
{
"Product": "mysql"
}
{
"Response": {
"BackupCount": 15,
"BackupVolume": 90000,
"BillingVolume": 20000,
"FreeVolume": 70000,
"RemoteBackupVolume": 1000,
"BackupArchiveVolume": 1000,
"BackupStandbyVolume": 1000,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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.SubAccountDenied | The sub-account has no permissions. |
| InternalError.CdbError | System error. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InvalidParameter | Parameter error. |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
文档反馈