Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the list of Redis instance backups.
A maximum of 20 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: redis.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: DescribeInstanceBackups. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ID of the instance to be operated on, which can be obtained through the InstanceId field in the return value of the DescribeInstance API. |
| Limit | No | Integer | Instance list size. Default value: 20 |
| Offset | No | Integer | Offset, which is an integral multiple of Limit |
| BeginTime | No | String | Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range. |
| EndTime | No | String | End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range. |
| Status.N | No | Array of Integer | 1: backup in process; 2: backing up normally; 3: converting from backup to RDB file; 4: RDB conversion completed; -1: backup expired; -2: backup deleted. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of backups |
| BackupSet | Array of RedisBackupSet | Array of instance backups |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://redis.tencentcloudapi.com/?Action=DescribeInstanceBackups
&Limit=5&Offset=0
&InstanceId=crs-5a4py64p
&<Common request parameters>{
"Response": {
"RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4",
"TotalCount": 2,
"RedisBackupSet": [
{
"StartTime": "2018-09-04 12:51:21",
"BackupId": "2e4127f8-affe-11e8-941e-4846fb00c75d",
"BackupType": "0",
"Status": 2,
"Remark": "For testing",
"Locked": 0
},
{
"StartTime": "2018-09-04 12:53:06",
"BackupId": "6cbbf53a-affe-11e8-905b-4846fb00c75d",
"BackupType": "0",
"Status": 2,
"Remark": "xxx",
"Locked": 0
}
]
}
}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 |
|---|---|
| InternalError.DbOperationFailed | Internal system error with the database operation, which may be update, insert, select, etc. |
| InternalError.InternalError | Internal error. |
| InvalidParameter.InvalidParameter | Invalid service parameter. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
Was this page helpful?