CreateBackup - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Creates a backup set for an ApsaraDB for MongoDB instance.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:CreateBackup	create	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	d-bp2235****
BackupMethod	string	No	The backup method of the instance. Valid values: Logical Physical (default) 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.	Logical

Response parameters

Parameter	Type	Description	Example
	object	The data that is returned.
BackupId	string	The ID of the backup set.	5664****
RequestId	string	The request ID.	7016B12F-7F64-40A4-BAFF-013F02AC82FC

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidBackupMethod.ValueNotSupport	The specified parameter BackupMethod is not valid.	-
403	OperationDenied.BackupJobExists	The operation is not permitted due to backup job exist.	A backup task is in progress. Try again later.
403	OperationDenied.NoDatabase	The operation is not permitted due to no database.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-07	The Error code has changed	View Change Details