查询云数据库 Tair(兼容 Redis)集群实例的备份列表。
接口说明
本接口仅适用于云原生版实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:DescribeClusterBackupList | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实例所属的地域 ID,可调用 DescribeRegions 接口获取。 | cn-zhangjiakou |
InstanceId | string | 是 | 实例 ID。 | r-t4nj72oug5r5646qog |
ClusterBackupId | string | 否 | 集群备份集 ID。 | cb-hyxdof5x9kqbtust |
PageSize | integer | 否 | 每页可展示的记录数。 枚举值:
| 30 |
PageNumber | integer | 否 | 当前页的页码。 | 1 |
StartTime | string | 是 | 查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。 | 2024-06-28T08:26Z |
EndTime | string | 是 | 查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。 | 2024-07-01T09:26Z |
返回参数
示例
正常返回示例
JSON
格式
{
"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": "r-bp1y4is8svonly****-db-0",
"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%"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-23 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-22 | OpenAPI 返回结构发生变更 | 查看变更详情 |