DescribeClusterRecoverTime - 查询分片集群可恢复时间段 - 云数据库 MongoDB

查询云数据库 MongoDB 版云盘版分片集群实例的可恢复时间。

接口说明

MongoDB 实例需要为分片集群实例，大版本为 4.4 及以上版本，存储模式为 ESSD 云盘版。
仅 2023 年 10 月 19 日之前创建的实例需要调用 TransferClusterBackup 接口切换至集群备份模式。已切换集群备份模式或 2023 年 10 月 19 日及以后新建的 MongoDB 云盘版分片集群实例可以直接调用该接口。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dds:DescribeClusterRecoverTime	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bp18f7d6b6a7****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	60EEBD77-227C-5B39-86EA-D89163C5****
RestoreRanges	array<object>	集群备份集列表。集群备份里面包含每个节点的备份集。
	object
RestoreBeginTime	string	可恢复开始时间。	2023-10-16T19:33:20Z
RestoreEndTime	string	可恢复结束时间。	2023-10-16T19:43:20Z
RestoreType	string	恢复方式，取值说明： PointInTime（默认）：基于时间点恢复。	PointInTime

示例

正常返回示例

JSON格式

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "RestoreRanges": [
    {
      "RestoreBeginTime": "2023-10-16T19:33:20Z",
      "RestoreEndTime": "2023-10-16T19:43:20Z",
      "RestoreType": "PointInTime"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-01-29	API 内部配置变更，不影响调用	查看变更详情