DescribeRestoreDBInstanceList - 查询MongoDB实例的备份恢复实例 - 云数据库 MongoDB

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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	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 3.4	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.	该实例不存在，原因可能是该实例已经释放，请刷新页面。

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