Trigger On-Demand MongoDB Backups with the CreateBackup API - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Operation description

The instance must be in the Running state.

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:CreateBackup

create

*dbinstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	d-bp2235****
BackupMethod	string	No	The backup method. Valid values: Snapshot: A snapshot backup. Logical: A logical backup. Physical (default): A physical backup. Note Instances with cloud disks support only snapshot backups. This parameter applies only to replica set and sharded cluster instances. This parameter is not required for standalone instances, which use snapshot backups.	Logical
BackupRetentionPeriod	integer	No	The backup retention period in days. This parameter applies only to replica set and sharded cluster instances that use cloud disks. Note If you do not specify this parameter, the retention period from the default backup policy is used. You can set this parameter to one of the following values: A value from 7 to 730 -1 (permanent retention)	30

Response elements

Element	Type	Description	Example
	object	The returned data.
BackupId	string	The backup ID. Note This parameter is deprecated. To obtain the backup ID, call the DescribeBackups operation.	5664****
RequestId	string	The request ID.	7016B12F-7F64-40A4-BAFF-013F02AC82FC
BackupJobId	string	The backup job ID.	775051

Examples

Success response

JSON format

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

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.