调用CheckRecoveryCondition接口检查MongoDB实例是否满足数据恢复的条件。

本接口适用于副本集实例或分片集群实例。

说明 调用本接口确认满足数据恢复的条件后，您可以调用CreateDBInstance接口，将数据恢复至新实例。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
SourceDBInstance String 是 dds-bpxxxxxxxx

待恢复的源实例ID。
Action String 否 CheckRecoveryCondition

要执行的操作，取值：CheckRecoveryCondition。

DatabaseNames String 否 ["db1","db2"]

所需恢复的数据库名，格式为JSON数组。

说明 如果不传入本参数，则恢复所有数据库。
RestoreTime String 否 2019-08-22T08:00:00Z

实例所需恢复的时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明
  • 本参数可取值为7天内的任意时间，但是须早于当前时间，且晚于实例的创建时间。
  • 本参数和BackupId参数两者中必须传入一项。
BackupId String 否 5664xxxx

备份ID。

说明
  • 您可以通过调用DescribeBackups接口查询备份ID。
  • 本参数和RestoreTime参数两者中必须传入一项。
  • 分片集群实例不支持传入本参数。
AccessKeyId String 否 LTAIgbTGpxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
IsValid Boolean true

是否满足恢复条件，返回值为：

  • true：满足条件。
  • flase：不满足条件。
RequestId String D563A3E7-6010-45FE-A0CD-9283414C9657

请求ID。
DBInstanceName String dds-bpxxxxxxxx

实例ID。

示例

请求示例


http(s)://mongodb.aliyuncs.com/?Action=CheckRecoveryCondition
&SourceDBInstance=dds-bpxxxxxxxx
&RestoreTime=2019-08-22T08:00:00Z
&<公共请求参数>

正常返回示例

XML 格式 

<CheckRecoveryConditionResponse>
	  <IsValid>true</IsValid>
	  <RequestId>D563A3E7-6010-45FE-A0CD-9283414C9657</RequestId>
	  <DBInstanceName>dds-bpxxxxxxxx</DBInstanceName>
</CheckRecoveryConditionResponse>

JSON 格式 

{
	"IsValid":true,
	"RequestId":"D563A3E7-6010-45FE-A0CD-9283414C9657",
	"DBInstanceName":"dds-bpxxxxxxxx"
}

错误码

HttpCode 错误码 错误信息 描述
403 IncorrectDBInstanceType Current DB instance type does not support this operation. 当前的实例类型不支持此操作。

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