Query Backup Details
Last Updated:2021-08-30
Query the Backup Details
Request structure
GET /v{version}/instance/{dbInstanceId}/backup/{backupId} HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
Request 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 | The API version number |
dbInstanceId | string | Yes | URL Parameter | The specified instance ID |
backupId | string | Yes | URL Parameter | The specified backup ID |
Return header field
There are no other special header fields except for the common header field.
Return parameter
Parameter Name | Type | Description |
---|---|---|
backupId | string | Backup ID |
backupSize | string | Backup size Unit: byte |
backupMethod | string | Backup method, Value Reference |
bakupMode | string | Backup mode, Value Reference |
backupType | string | Backup type, Value Reference |
backupStatus | string | Backup status, Value Reference |
backupStartTime | DateTime | Backup start time |
backupEndTime | DateTime | Backup end time |
downloadUrl | string | Backup download address |
downloadExpires | string | Download address expiration date. Unit: s |
backupDescription | string | Backup details |
Request example
GET /v1/instance/m-gGWeCM/backup/backup-04oeZM HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
Return example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Content-Type: application/json;charset=UTF-8
{
"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",
"downloadExpires": 3600,
"downloadUrl": "http://bj.bcebos.com/bj-backup-03/manual/m-7TQa6m/rep-psFzBo/backup-04oeZM_20200806164138.gz?authorization=bce-auth-v1%2Fa802312152c34729affc9b1b28dea1d9%2F2020-08-06T08%3A55%3A46Z%2F3600%2Fhost%2F9ba508445ce5c302fdd905475f469cc1714dbf00d36d257a7530231f664df541"
}