Query Backup List
Last Updated：2021-12-20
Query a Backup List
Request structure
GET /v{version}/instance/{dbInstanceId}/backup?marker={marker}&maxKeys={maxKeys} HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization stringRequest header field
No other special header fields are available except for 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 |
| marker | string | No | Query parameters | Start position of the query for getting list by batch. |
| maxKeys | int | No | Query parameters | Maximum number of master instances on each page, which usually does not exceed 1,000 and whose default value is 10. |
Return header field
There are no other special header fields except for the common header field.
Return parameter
| Parameter Name | Type | Description |
|---|---|---|
| marker | String | The start position of the query for getting lists in batch. |
| maxKeys | int | The maximum number of keys contained on each page. |
| isTruncated | boolean | “True” means there is still data behind it, and “False” means it is already the last page. |
| nextMarker | String | Gets the “marker” value to be passed on the next page. This field does not appear when “isTruncated” is false. |
| backups | List BackupModel | Backups list |
Request example
GET /v1/instance/m-gGWeCM/backup?marker=-1&maxKeys=10 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
{
"marker": "-1",
"maxKeys": 10,
"isTruncated": false,
"backups": [
"backupDescription": "logical_backup",
"backupEndTime": "2020-08-06T08:41:46Z",
"backupId": "backup-04oeZM",
"backupMethod": "Logical",
"backupMode": "Manual",
"backupSize": 762,
"backupStartTime": "2020-08-06T08:41:38Z",
"backupStatus": "SUCC",
"backupType": "FullBackup",
]
}