Queries the backup sets of a Tair (Redis OSS-compatible) cluster instance.
Operation description
This operation is applicable only to cloud-native instances.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| kvstore:DescribeClusterBackupList | get | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. | cn-zhangjiakou |
| InstanceId | string | Yes | The instance ID. | r-t4nj72oug5r5646qog |
| ClusterBackupId | string | No | The backup set ID. | cb-hyxdof5x9kqbtust |
| PageSize | integer | No | The number of entries per page. Valid values:
| 30 |
| PageNumber | integer | No | The page number. | 1 |
| StartTime | string | Yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. | 2018-12-03T07:01Z |
| EndTime | string | Yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time. | 2021-05-13T00:00:00Z |
| NoShardBackup | string | No | Specifies whether to show backup set information for shards in the instance.
Valid values:
| True |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "C009DA42-3B19-5B81-963D-1509DE2408DD",
"MaxResults": 4,
"PageNumber": 1,
"PageSize": 30,
"FullStorageSize": 1000,
"LogStorageSize": 5000,
"FreeSize": 100000,
"ClusterBackups": [
{
"IsAvail": 1,
"ClusterBackupId": "cb-zmdqj2m3xyxjtdt0",
"ClusterBackupStatus": "OK",
"ClusterBackupSize": "2048",
"ClusterBackupStartTime": "2024-01-10T17:21:25Z",
"ClusterBackupEndTime": "2024-01-10T17:21:55Z",
"ClusterBackupMode": "Automated",
"ShardClassMemory": 1024,
"Backups": [
{
"BackupId": "514645788",
"InstanceName": "hins100322105_data_20240108012127.rdb",
"BackupDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
"BackupIntranetDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
"RecoverConfigMode": "null",
"BackupStartTime": "2024-01-09T17:21:30Z",
"BackupEndTime": "2024-01-09T17:21:57",
"BackupSize": "1024",
"IsAvail": "1",
"BackupStatus": "OK",
"BackupName": "hins100322105_data_20240110012135.rdb",
"Engine": "redis",
"ExtraInfo": {
"CustinsDbVersion": "5.0"
}
}
],
"Progress": "100%"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-04-22 | The response structure of the API has changed | View Change Details |
| 2025-01-15 | The request parameters of the API has changed | View Change Details |
| 2024-12-27 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-05-23 | The response structure of the API has changed | View Change Details |
| 2024-01-22 | The response structure of the API has changed | View Change Details |