Instructions for Backup Management Interfaces

Last Updated：2021-10-29

Get a backups list

Get a backups list under an instance.

Request structure

GET /v{version}/instance/{instanceId}/backup HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization authorization string

Request header field

There are no other special header fields except the common header field.

Request parameters

Parameter Name	Type	Required	Parameter Position	Description
version	string	Yes	URL 0	API Version Number
instanceId	string	Yes	URL Parameters	Instance ID
marker	string	No	Query Parameter	The start position of the query for getting list by batch is a character string generated by the system
maxKeys	int	No	Query Parameters	The maximum number contained in each page (main instance) is usually no more than 1000, the default value is 1000.

Return header fields

No other special header fields are available, except for common header fields.

Return parameters

Parameter Name	Type	Description
marker	string	The start position of the query to obtain the list by batch, which is a character string generated by the system.
maxKeys	int	The maximum number contained in each page (main instance) is usually no more than 1000, the default value is 1000.
isTruncated	boolean	True means there is still data behind, and false means it is already the last page.
nextMarker	string	Get the marker value to pass on the next page. This field does not appear when isTruncated is false.
instances	List Instance	The array composed of Instance objectS.

Request example

GET /v{version}/instance/{instanceId}/backup?marker=snap-xxx-xxxx&maxKeys=2 HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization bce-auth-v1/rdsak/2016-07-03T06:13:13Z/1800/x-bce-date/{signature}

Return example

HTTP/1.1 200 OK
x-bce-request-id 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
Content-Length: 567

{
    "nextMarker": "snap-xxx-xxxx",
    "marker": "snap-xxx-xxxx",
    "maxKeys": 2,
    "isTruncated": true,
    "backups":[{
        "backupId"          : "snap-xxx-xxxx",
        "backupSize" : 12,
        "backupType"        : "Manual",
        "backupStatus"      : "Available",
        "backupStartTime"   : "2016-06-01T12:00:11Z",
        "backupEndTime"     : "2016-06-01T13:00:11Z"
    },{
        "backupId"          : "snap-xxx-xxxx",
        "backupSize" : 12,
        "backupType"        : "Manual",
        "backupStatus"      : "Available",
        "backupStartTime"   : "2016-06-01T12:00:11Z",
        "backupEndTime"     : "2016-06-01T13:00:11Z"
    }]
}

Get backup information

Get backups information. The valid time for downloading link is 1800s. Valid downloading time refers to the valid time for downloading link, rather than download time.