Domain name for API request: cdb.tencentcloudapi.com.
This API (DescribeBackups) is used to query the backups of a TencentDB instance.
A maximum of 10 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: 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 in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. |
| Offset | No | Integer | Offset. Minimum value: 0. |
| Limit | No | Integer | Number of entries per page. Value range: 1-100. Default value: 20. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible instances. |
| Items | Array of BackupInfo | Details of eligible 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=DescribeBackups
&InstanceId=cdb-c1nl9rpv
&<Common request parameters>{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"Items": [
{
"Status": "SUCCESS",
"FinishTime": "2017-07-23 12:03:42",
"Name": "ivansqwutestdr_backup_20170429000134",
"IntranetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"Creator": "SYSTEM",
"BackupId": 12445233,
"Date": "2017-04-29 00:01:34",
"InternetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"Type": "logical",
"Size": 653226
},
{
"Status": "SUCCESS",
"FinishTime": "2017-07-23 12:03:42",
"Name": "ivansqwutestdr_backup_20170430000129",
"IntranetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"Creator": "SYSTEM",
"BackupId": 436184134,
"Date": "2017-04-30 00:01:29",
"InternetUrl": "http://gz.xxxxxxxxxxxxxxxxx",
"Type": "logical",
"Size": 653226
}
]
}
}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 |
|---|---|
| CdbError | Backend or process error. |
| InternalError.DatabaseAccessError | Internal database error. |
| InternalError.DesError | Internal system error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| OperationDenied.WrongStatus | The backend task status is invalid. |
Was this page helpful?