All Products
Document Center

ApsaraDB for MongoDB:RestoreDBInstance

Last Updated:Jan 17, 2023

You can call this operation to restore data to the current ApsaraDB for MongoDB instance.

Operation Description

This operation is applicable to replica set instances, but cannot be called on standalone instances or sharded cluster instances. You can use the following methods to clone an instance: Create an instance from a backup to clone a standalone instance. Call the CreateShardingDBInstance operation to clone a sharded cluster instance.

Note This operation overwrites the data of the current instance, and the data cannot be recovered. Exercise caution when performing this operation.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:RestoreDBInstance WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of an instance.

BackupId integer Yes

The ID of the backup.

Note You can call the DescribeBackups operation to query the backup ID.

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


  "RequestId": "973DCB8F-56B3-4102-8777-3A90495927F7"

Error codes

Http code Error code Error message
403 InvalidBackupID.NotFound Specified backup set ID does not exist.
403 OperationDenied.InsufficientResourceCapacity The operation is not permitted due to InsufficientResourceCapacity of instance.
403 OperationDenied.DBInstance The operation is not permitted due to type of instance.

For a list of error codes, visit the API error center.