DescribeClusterBackupList_云数据库 Tair(兼容 Redis®)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为1000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
kvstore:DescribeClusterBackupList
Get
DBInstance
acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-zhangjiakou参考取值来源:
    DescribeRegions
InstanceIdstring

实例 ID。

示例值:r-t4nj72oug5r5646qog参考取值来源:
    CreateInstance
    ModifyInstanceSSL
    RestoreInstance
    RestartInstance
    DescribeInstances
ClusterBackupIdstring

集群备份集 ID。

示例值:cb-hyxdof5x9kqbtust
PageSizeinteger<int32>

每页可展示的记录数。

示例值:30枚举值:30501002003005101520
PageNumberinteger<int32>

当前页的页码。

示例值:1
StartTimestring

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

示例值:2024-06-28T08:26Z
EndTimestring

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

示例值:2024-07-01T09:26Z
NoShardBackupstring

是否展示集群节点的备份集详情:展开详情

示例值:True枚举值:TrueFalse

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:C009DA42-3B19-5B81-963D-1509DE2408DD
MaxResultsinteger<int32>

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

示例值:4
PageNumberinteger<int32>

第几页,同请求参数

示例值:1
PageSizeinteger<int32>

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

示例值:30
FullStorageSizeinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1000
LogStorageSizeinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:5000
FreeSizeinteger<int64>

该实例的免费备份额度,单位是字节,免费额度为实例规格默认内存量,更多信息请参见备份商业化通知。 全量备份和日志备份共享该免费额度。当变配实例规格时,实例的免费额度会产生变化。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:100000
ClusterBackupsarray<object>

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

返回示例

变更历史

变更时间变更内容概要操作
2025-04-22
变更返回参数
2025-01-15
新增请求参数NoShardBackup
2024-12-27
变更请求参数PageSize
2024-05-23
变更返回参数
2024-01-22
变更返回参数

相关示例