全部产品
Search
文档中心

云原生内存数据库Tair:DescribeClusterBackupList - 查询集群实例的备份列表

更新时间:Jun 07, 2024

查看Redis、Tair集群实例的备份列表。

接口说明

本接口仅适用于云盘版实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeClusterBackupListRead
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

实例所属的地域 ID,可调用 DescribeRegions 接口获取。

cn-zhangjiakou
InstanceIdstring

实例 ID。

r-t4nj72oug5r5646qog
ClusterBackupIdstring

集群备份集 ID。

cb-hyxdof5x9kqbtust
PageSizeinteger

每页可展示的记录数。

枚举值:
  • 30
  • 50
  • 100
  • 200
  • 300
30
PageNumberinteger

当前页的页码。

1
StartTimestring

查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2018-12-03T07:01Z
EndTimestring

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-05-13T00:00:00Z

返回参数

名称类型描述示例值
object

请求响应

RequestIdstring

请求 ID。

C009DA42-3B19-5B81-963D-1509DE2408DD
MaxResultsinteger

MaxResults 本次请求所返回的最大记录条数

4
PageNumberinteger

第几页,同请求参数

1
PageSizeinteger

一页最大多少条记录,同请求参数

30
FullStorageSizelong

当前实例全量备份文件的大小,单位是字节。全量备份来源于每天定时备份、手动备份、缓存分析时生成的备份等。

说明 该值和当前请求所响应的备份集数量以及大小无关,而是该实例当前所有有效全量备份的大小。
1000
LogStorageSizelong

当前实例日志备份文件的大小,单位是字节,当且仅当开启闪回时才有效。

说明 该值和当前请求所响应的备份集数量以及大小无关,而是该实例当前所有有效日志备份的大小。
5000
FreeSizelong

该参数未生效,请忽略该参数。

100000
ClusterBackupsobject []

集群备份集列表,一个集群备份里面包含各个节点的备份集

IsAvailinteger

集群备份集是否有效,子节点的备份集未完成或者失败时,为 0

1
ClusterBackupIdstring

集群备份集 ID

cb-zmdqj2m3xyxjtdt0
ClusterBackupStatusstring

集群备份集状态。

  • 成功:OK
  • 运行中:RUNNING
  • 失败:其他字段
OK
ClusterBackupSizestring

集群备份集大小

2048
ClusterBackupStartTimestring

集群备份开始时间。

2024-01-10T17:21:25Z
ClusterBackupEndTimestring

集群备份结束时间。

2024-01-10T17:21:55Z
ClusterBackupModestring

集群备份模式。

Automated
ShardClassMemoryinteger

做全量备份时,当时单个 DB 节点的内存规格大小,单位为 MB

1024
Backupsobject []

单个集群备份集下,各个子节点的备份集集合

BackupIdstring

备份文件的 ID。

514645788
InstanceNamestring

实例的名称。

r-bp1y4is8svonly****-db-0
BackupDownloadURLstring

备份文件的外网下载地址。

http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
BackupIntranetDownloadURLstring

备份文件的内网下载地址。

说明 您可以在与该 Redis 实例连通的 ECS(二者需属于同地域的经典网络或者在同一 VPC 内)上使用该地址下载目标备份文件。
http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
RecoverConfigModestring

该参数暂未生效,请忽略该参数。

null
BackupStartTimestring

本次备份开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2024-01-09T17:21:30Z
BackupEndTimestring

本次备份结束时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2024-01-09T17:21:57
BackupSizestring

备份文件大小,单位为 Byte。

1024
IsAvailstring

备份集是否可用,取值说明:

  • 0:不可用。
  • 1:可用。
1
BackupStatusstring

备份状态,返回值:

  • OK:成功。
  • ERROR:失败。
OK
BackupNamestring

备份名称。

hins100322105_data_20240110012135.rdb
Enginestring

数据库类型,返回值固定为 redis

redis
ExtraInfoobject

附加信息

CustinsDbVersionstring

DB 的版本

5.0
Progressstring

备份进度,仅正在运行的备份才会显示进度

100%

示例

正常返回示例

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-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-01-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更