DescribeClusterBackups_云数据库 MongoDB 版_API文档-阿里云OpenAPI开发者门户

接口说明

2023 年 10 月 19 日前新建的云盘版分片集群实例，在调用前本接口前，需要调用 TransferClusterBackup 接口，完成分片备份到集群备份的转换。

2023 年 10 月 19 日之后新建的云盘版分片集群实例，默认使用集群备份。

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

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dds:DescribeClusterBackups	Get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	无	无

字段名称	字段详情
DBInstanceIdstring	实例 ID。示例值:dds-bp16cb162771****参考取值来源: CreateDBInstance DescribeDBInstances
BackupIdstring	集群备份 ID。示例值:5664****参考取值来源: CreateBackup DescribeBackups
PageNointeger<int32>	分页页号。默认值为 1，取值范围为正整数。示例值:1取值 >= 1
PageSizeinteger<int32>	每页记录数，取值：展开详情示例值:30枚举值:305010010205
StartTimestring	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。示例值:2019-03-13T12:11Z
EndTimestring	查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。示例值:2019-03-14T13:10Z
IsOnlyGetClusterBackUpboolean	是否查询集群备份下的子节点信息。取值说明：展开详情示例值:true
SrcRegionstring	实例所在地域。展开详情示例值:cn-hangzhou
DestRegionstring	异地备份所在地域。展开详情示例值:cn-shanghai

字段名称	字段详情
RequestIdstring	请求 ID。示例值:2F42BB4E-461F-5B55-A37C-53B1141C****
MaxResultsinteger<int32>	本次请求所返回的最大记录条数。示例值:10
PageNumberinteger<int32>	页码。示例值:1
PageSizeinteger<int32>	每页最大记录数量。示例值:30
ClusterBackupsarray<object>	集群备份集列表，一个集群备份里面包含各个节点的备份集。

没有我想要的错误码, 点击反馈

HTTP 状态码	错误码	错误信息	操作

400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.	诊断
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.	诊断
400	InvalidStartTimeAndEndTime.Malformed	The Specified parameter StartTime or EndTime is not valid.	诊断
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	诊断

	变更时间	变更内容概要	操作
	2024-10-29	变更返回参数
	2024-05-16	新增请求参数SrcRegion 新增请求参数DestRegion 变更返回参数