Contents：
1. API Description
Domain name for API request: cdb.tencentcloudapi.com.
This API (DescribeBackups) is used to query the backup data of a database instance.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com.
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 parameter. The value used for this API: DescribeBackups |
| 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. |
| InstanceId | Yes | String | Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page. |
| Offset | No | Integer | Offset. The minimum value is 0. |
| Limit | No | Integer | Number of results returned for a single request. Default is 20, and maximum is 100. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of instances that meet the condition |
| Items | Array of BackupInfo | Details of the backups that meet the condition |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| CdbError | Backend error or process error. |
| InternalError.DatabaseAccessError | Database's internal error. |
| InternalError.DesError | System's internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| OperationDenied.WrongStatus | The backend task status is invalid. |
5. Example
Example 1 Query backup logs
Input example
https://cdb.tencentcloudapi.com/?Action=DescribeBackups
&InstanceId=cdb-c1nl9rpv
&<Common request parameters>Output example
{
"Response": {
"Items": [
{
"BackupId": 12445233,
"Creator": "SYSTEM",
"Date": "2017-04-29 00:01:34",
"FinishTime": "2017-07-23 12:03:42",
"InternetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"IntranetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"Name": "ivansqwutestdr_backup_20170429000134",
"Size": 653226,
"Status": "SUCCESS",
"Type": "logical"
},
{
"BackupId": 436184134,
"Creator": "SYSTEM",
"Date": "2017-04-30 00:01:29",
"FinishTime": "2017-07-23 12:03:42",
"InternetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"IntranetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"Name": "ivansqwutestdr_backup_20170430000129",
"Size": 653226,
"Status": "SUCCESS",
"Type": "logical"
}
],
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.
