All Products
Document Center

ApsaraDB for MongoDB:CreateBackup

Last Updated:Jan 17, 2023

Manually backs up an ApsaraDB for MongoDB instance.

Operation Description


When you call this operation, the instance must be in the Running state.

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:CreateBackup WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

BackupMethod string No

The backup method of the instance. Default value: Physical. Valid values:

  • Logical
  • Physical
Note Only replica set instances and sharded cluster instances support this parameter. You do not need to specify this parameter for standalone instances. All standalone instances use snapshot backup.

Response parameters

Parameter Type Description Example
BackupId string

The ID of the backup set.

RequestId string

The ID of the request.



Normal return example


  "BackupId": "5664****",
  "RequestId": "7016B12F-7F64-40A4-BAFF-013F02AC82FC"

Error codes

Http code Error code Error message
400 InvalidBackupMethod.ValueNotSupport The specified parameter BackupMethod is not valid.
403 OperationDenied.BackupJobExists The operation is not permitted due to backup job exist.
403 OperationDenied.NoDatabase The operation is not permitted due to no database.

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