Create Backup
Last Updated：2021-12-20
Create a Backup
Request structure
POST /v{version}/instance/{dbInstanceId}/backup HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
{
"backupMethod": backupMethod,
"backupDescription": backupDescription
}Request header field
No other special header fields are available except for the common header fields.
Request parameter
| Parameter Name | Type | Required? | Parameter Position | Description |
|---|---|---|---|---|
| version | string | Yes | URL parameter | API version number |
| dbInstanceId | string | Yes | URL parameter | Specified instance ID |
| backupMethod | string | Yes | RequestBody parameter | Backup method. Value Reference |
| backupDescription | string | No | RequestBody parameter | Backup remark information |
Return header field
There are no other special header fields except for the common header field.
Return parameter
| Parameter Name | Type | Description |
|---|---|---|
| backupId | string | Create a backup ID |
Request example
POST /v1/instance/m-gGWeCM/backup HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
{
"backupMethod": "Physical",
"backupDescription": "mybackup"
}Return example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Content-Type: application/json;charset=UTF-8
{
"backupId":"backup-TBZD2w"
}