Description
- Query an instance backup list
Request Structure
GET /v1/instance/{instanceId}/backup HTTP/1.1
Host: redis.{region}.baidubce.com
Authorization authorization string
There are no other special header fields except the public header field.
Request Parameter
| Parameter Name |
Type |
Required |
Parameter Position |
Description |
| version |
string |
Yes |
URI Parameter |
API version No. |
| instanceId |
string |
Yes |
URI Parameter |
Instance ID to be queried |
Request Example
GET /v1/instance/scs-bj-ykfiztgpxjny/backup HTTP/1.1
HOST: redis.bj.baidubce.com
ContentType: application/json
Authorization bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
There are no other special header fields except the public header field.
Return Parameters
| Parameter Name |
Type |
Description |
| totalCount |
int |
Total number of backup records |
| backups |
List |
Backups list |
| Parameter Name |
Type |
Description |
| backupType |
string |
"auto" means the automatic backup and "manual" means the manual backup |
| comment |
string |
Remarks |
| records |
list |
Current backup record list |
| startTime |
string |
Instance backup start time |
backupRecord - Single backup record
| Parameter Name |
Type |
Description |
| backupRecordId |
int |
backup record id |
| backupStatus |
string |
initialization/success/doing/failed/expired |
| duration |
int |
Backup duration |
| objectSize |
int |
Backup file size |
| shardName |
string |
Multipart name |
| startTime |
string |
Multipart backup start time |
Return Example
PUT /v1/instance/scs-bj-ykfiztgpxjny/backup HTTP/1.1
HOST: redis.bj.baidubce.com
ContentType: application/json
Authorization bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"totalCount": "1",
"backups": [
{
"batchId": "431ff186-a516-425d-8646-60829bbe8405",
"backupType": "manual",
"comment": "",
"startTime": "2019-08-16T08:10:07Z",
"records": [
{
"backupRecordId": "2388",
"shardName": "Shard-0",
"startTime": "2019-08-16T08:10:07Z",
"duration": "0",
"objectSize": "0",
"backupStatus": "failed"
}
]
}
]
}
