You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.

This operation is applicable to replica set instances or sharded cluster instances.

Note After confirming that the data recovery conditions are met by calling this operation, you can call the CreateDBInstance operation to restore data to a new instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
SourceDBInstance String Yes dds-bpxxxxxxxx

The ID of the source instance.

Action String No CheckRecoveryCondition

The operation that you want to perform. Set the value to CheckRecoveryCondition.

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

The name of the database. It is in the JSON array format.

Note If this parameter is not specified, all databases are restored.
RestoreTime String No 2019-08-22T08:00:00Z

The time when the instance is restored. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note
  • It can be any time within the past seven days. The time must be earlier than the current time, but later than the time when the database was created.
  • You must specify either this parameter or the BackupId parameter.
BackupId String No 5664xxxx

The backup ID.

Note
  • Call DescribeBackups to query the backup ID.
  • You must specify either this parameter or the RestoreTime parameter.
  • This parameter is not applicable to sharded cluster instances.
AccessKeyId String No LTAIgbTGpxxxxxx

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
IsValid Boolean true

Indicates whether the recovery conditions are met. Valid values:

  • true
  • false
RequestId String D563A3E7-6010-45FE-A0CD-9283414C9657

The ID of the request.

DBInstanceName String dds-bpxxxxxxxx

The ID of the instance.

Examples

Sample requests


http(s)://mongodb.aliyuncs.com/? Action=CheckRecoveryCondition
&SourceDBInstance=dds-bpxxxxxxxx
&RestoreTime=2019-08-22T08:00:00Z
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HTTP status code Error code Error message Description
403 IncorrectDBInstanceType Current DB instance type does not support this operation. The error message returned because the operation is not supported by the current instance type.

For a list of error codes, visit the API Error Center.