Docs

Document Database for MongoDB

Backup and recovery

CreateBackup

CreateBackup

Call the CreateBackup API to manually create backup for target MongoDB instance.

Request type

Asynchronous request.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Request parameters

InstanceId String required Sample value: mongo-shard-f9e5d782****

Instance ID.

tip

Call the DescribeDBInstances API to query basic information of all MongoDB instances in the target region, including the instance ID.

BackupType String Optional Sample value: Physical

Backup type. The value range is as follows:

Physical: Physical backup.

Logical (default): Logical backup.

tip

Whether using logical or physical backup methods, the backup object is data backup. For more information, refer to Backup methods and Backup objects.

Response parameters

The current API has no specified response parameters. For more information, see Response structure.

Example

Request example

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=CreateBackup&Version=2022-01-01 HTTP/1.1​
Host: mongodb.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "InstanceId": " mongo-shard-f9e5d782****",​
    "BackupType": "Physical"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "202306041104200100100232280022D31",​
        "Action": "CreateBackup",​
        "Version": "2022-01-01",​
        "Service": "mongodb",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

Error code

For more details, see Error code.

Last updated: 2026.07.23 14:28:26