使用DescribeRestoreDBInstanceList查询可恢复的MongoDB实例列表-云数据库 MongoDB 版-阿里云

查询MongoDB实例7天以内的备份恢复实例列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeRestoreDBInstanceList

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	页码。	1
PageSize	integer	否	每页记录数。	30
DBInstanceId	string	是	实例 ID。	dds-bp114f14849d****
CreationTimeAfter	string	是	查找实例创建时间在该时间以后的实例，格式为yyyy-MM-ddTHH:00:00Z（UTC 时间）。说明时间为整点时间时间不能早于当前时间-7 天。	2024-07-24T14:00:00Z

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	查询结果中实例的数量。	5
RequestId	string	请求 ID。	1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
PageSize	integer	每页记录数。	30
PageNumber	integer	页码。	1
DBInstances	object
DBInstance	array<object>	实例信息列表。
	object	实例信息列表。
CreationTime	string	实例创建的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-01-02T07:43:59Z
LockMode	string	实例的锁定状态，取值说明： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：实例过期自动锁定。 LockByRestoration：实例回滚前自动锁定。 LockByDiskQuota：实例空间满自动锁定。	Unlock
EngineVersion	string	数据库版本号，取值： 7.0 6.0 5.0 4.4 4.2 4.0	4.2
DBInstanceDescription	string	实例的描述或备注信息。	测试数据库
DBInstanceType	string	实例类型，取值说明： sharding：分片集群实例。 replicate：副本集实例。	replicate
DBInstanceStatus	string	实例状态，详情请参见实例状态表。	Running
RegionId	string	实例所属地域 ID。	cn-hangzhou
ZoneId	string	实例所属可用区 ID。	cn-hangzhou-g
DBInstanceId	string	实例 ID。	dds-bp12c5b040dc****
SecondaryZoneId	string	实现多可用区部署时，实例的备可用区 1。	cn-hangzhou-i
HiddenZoneId	string	实现多可用区部署时，实例的备可用区 2。	cn-hangzhou-h
IsDeleted	integer	是否被删除： 1：代表已被删除。 0：代表未被删除。	0

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "DBInstanceDescription": "测试数据库",
        "DBInstanceType": "replicate",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp12c5b040dc****",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "IsDeleted": 0
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter %s is not valid.	参数 %s 非有效参数。
400	InvalidDBInstanceId.NotFound	Specified instance does not exist.	该实例不存在，原因可能是该实例已经释放，请刷新页面。

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

变更历史

更多信息，参考变更详情。