Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the backup list of an instance.
A maximum of 50 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: DescribeInstanceBackups. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Limit | No | Integer | List size of output backup per page. Default size is 20, maximum value is 100. |
| Offset | No | Integer | Pagination offset, integer multiple of Limit. Calculation formula: offset=limit*(page number-1). |
| InstanceId | No | String | Instance ID to be operated. You can get it from the InstanceId in the return value from the DescribeInstance API. |
| BeginTime | No | String | Start time, for example, in the format of 2017-02-08 16:46:34. Query the backup list of instances that started backup during the [beginTime, endTime] period, with a maximum query span of 30 days. |
| EndTime | No | String | End time, in the format of 2017-02-08 19:09:26. Query the backup list of instances that started backup within the period of [beginTime, endTime]. The maximum query time span is 30 days. |
| Status.N | No | Array of Integer | Backup task status: |
| InstanceName | No | String | Instance name, supports name fuzzy search based on instance name. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of backups. |
| BackupSet | Array of RedisBackupSet | Backup array of the instance. |
| 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: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceBackups
<Common request parameters>
{
"InstanceId": "crs-ei43p3gr"
}{
"Response": {
"BackupSet": [
{
"BackupId": "165706342-5832225-1641692389",
"BackupSize": 537,
"BackupType": "1",
"Encrypted": false,
"EndTime": "2026-06-01 02:01:09",
"ExpireTime": "2026-06-08 02:00:48",
"FileType": "RDB-Redis 6.2",
"FullBackup": 0,
"InstanceId": "crs-ei43p3gr",
"InstanceName": "testbackup",
"InstanceType": 16,
"Locked": 0,
"Region": "ap-guangzhou",
"Remark": "",
"StartTime": "2026-06-01 02:00:48",
"Status": 2
}
],
"TotalCount": 6,
"RequestId": "66bb2e15-b864-46ea-894d-529885087fb8"
}
}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 |
|---|---|
| FailedOperation.SystemError | Internal system error, which is irrelevant to the business. |
| 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. |
| UnsupportedOperation | The operation is not supported. |
フィードバック