Use CheckRecoveryCondition to verify if an instance can be restored - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Checks whether an ApsaraDB for MongoDB instance meets the conditions for data restoration.

Operation description

This operation applies to replica set instances and sharded cluster instances.

Note

After you confirm that the instance data can be restored, call the CreateDBInstance operation to restore data to a new instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:CheckRecoveryCondition

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
SourceDBInstance	string	Yes	The ID of the source instance.	dds-bp1378****
DatabaseNames	string	No	The name of the source database. The value is a JSON array. Note If you do not specify this parameter, all databases are restored.	["db1","db2"]
RestoreTime	string	No	The point in time to which the instance is restored. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (ISO 8601, UTC). Note The value must be within the past seven days, earlier than the current time, and later than the instance creation time. You must specify one of the RestoreTime and BackupId parameters.	2022-08-22T08:00:00Z
BackupId	string	No	The backup ID. Note Call the DescribeBackups operation to query the backup ID. You must specify one of the RestoreTime and BackupId parameters. Not applicable to sharded cluster instances.	5664****
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	sg-bp179****
SourceDBInstance	string	Yes	The ID of the source instance.	dds-bp1378****
SrcRegion	string	No	The region where the source instance resides. Note Required when RestoreType is set to 2. Required when RestoreType is set to 3.	cn-beijing
DestRegion	string	No	The region of the backup set used for cross-region restoration. Note Required when RestoreType is set to 3.	cn-hangzhou
RestoreType	string	No	The restoration type. Note 0: The data of the source instance is restored to a new instance in the same region. 1: The data of the source instance is restored to an earlier point in time. 2: The data of a deleted instance is restored to a new instance from the backup set. 3: The data of a deleted instance is restored to a new instance in another region from the backup set.	0
InstanceType	string	No	The instance architecture. Valid values: replicate sharding Note Required when RestoreType is set to 2. Required when RestoreType is set to 3.	replicate
EngineVersion	string	No	The database engine version of the instance. 6.0 5.0 4.4 4.2 4.0 3.4	4.2

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	D563A3E7-6010-45FE-A0CD-9283414C9657
DBInstanceName	string	The instance ID.	dds-bp1378****
IsValid	boolean	Whether the instance data can be restored. Valid values: true: The data of the instance can be restored. false: The data of the instance cannot be restored.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidMeta.WrongFormat	Meta information is wrong formatter.
400	InvalidRestoreTime.Format	Specified restore time is not valid.	The specified RestoreTime value is invalid.
403	InvalidDBName	The specified database name is not allowed.	The specified database name is invalid.
403	InvalidMeta.TooLarge	Meta information is too large.	The metadata is too large.
403	SingleDBRestore.BackupSetNotSupport	This backup set do not support this operation.	Single-database recovery is not supported for the specified time point or backup file.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.	The operation is not supported when log backup is enabled.
403	IncorrectBackupSetState	Current backup set state does not support operations..
404	InvalidBackupSetID.NotFound	Specifiedbackup set ID does not exist.
404	InvalidBackup.NotFound	Theavailable backup does not exist in recovery time.	No backup set is available during the specified recovery period.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.