Domain name for API request: cdb.intl.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.
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: DescribeBackups. |
| 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. |
| 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, 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 list of data backup files.
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackups
<Common request parameters>
{
"InstanceId": "cdb-c1nl9rpv"
}
{
"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.tencent.com",
"Creator": "SYSTEM",
"BackupId": 12445233,
"Date": "2017-04-29 00:01:34",
"StartTime": "2017-07-22 00:01:34",
"InternetUrl": "http://gz.tencent.com",
"Type": "logical",
"Way": "automatic",
"ManualBackupName": "ab",
"SaveMode": "save_mode_regular",
"RemoteInfo": [],
"Region": "ap-guangzhou",
"Method": "full",
"CosStorageType": 0,
"Size": 653226
"InstanceId": "cdb-sadq",
"EncryptionFlag": "off"
},
{
"Status": "SUCCESS",
"FinishTime": "2017-07-23 12:03:42",
"StartTime": "2017-07-23 00:01:34",
"Name": "ivansqwutestdr_backup_20170430000129",
"IntranetUrl": "http://gz.tencent.com",
"Creator": "SYSTEM",
"BackupId": 436184134,
"Date": "2017-04-30 00:01:29",
"InternetUrl": "http://gz.tencent.com",
"Type": "logical",
"Way": "automatic",
"ManualBackupName": "abv",
"SaveMode": "save_mode_regular",
"RemoteInfo": [],
"Region": "ap-guangzhou",
"Method": "full",
"CosStorageType": 0,
"Size": 653226
"InstanceId": "cdb-asdqwdqd",
"EncryptionFlag": "on"
}
]
}
}
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. |
| CdbError | Backend or process error. |
| InternalError.CdbError | System error. |
| InternalError.DBError | Database exception |
| InternalError.DBOperationError | Database operation failed. |
| InternalError.DatabaseAccessError | Internal database error. |
| InternalError.DesError | Internal system error. |
| InternalError.FtpError | File transfer exception |
| InternalError.HttpError | Exceptional HTTP request |
| InternalError.UndefinedError | Unknown error |
| InternalError.UnknownError | Unknown error |
| InvalidParameter | Parameter error. |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
| OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
| OperationDenied.WrongStatus | The backend task status is invalid. |
| UnsupportedOperation | Unsupported operation. |