Query Backup Policy
Last Updated：2021-12-31
Query a Backup Policy
Request structure
GET /v{version}/instance/{dbInstanceId}/backupPolicy HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization stringRequest 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 | The API version number |
| dbInstanceId | string | Yes | URL parameter | The specified instance ID |
Return header field
There are no other special header fields except for the common header field.
Return Parameter
| Parameter Name | Type | Description |
|---|---|---|
| autoBackupEnable | string | Automatic backup status. Value Reference |
| preferredBackupPeriod | string | Backup period Value Reference. If required to pass in multiple values, separate them with commas (,) |
| preferredBackupTime | string | Backup time. The format is HH:mmZ-HH:mmZ. The time range is limited to 1 hour. |
| backupRetentionPeriod | int | Number of backup retention days. |
Request example
GET /v1/instance/m-gGWeCM/backupPolicy HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization stringReturn example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Content-Type: application/json;charset=UTF-8
{
"autoBackupEnable": "ON",
"backupRetentionPeriod": 7,
"preferredBackupPeriod": "Monday,Wednesday",
"preferredBackupTime": "01:00Z-02:00Z"
}