Obtaining the Link for Downloading a Backup
Function
This API is used to obtain the link for downloading a backup.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
This API is used to obtain the link for downloading a full or incremental backup of an instance.
URI
- URI format
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
backup_id
Yes
Definition
Specifies the backup ID.
Constraints
N/A
Range
N/A
Default Value
N/A
Response
- Normal response
Table 2 Parameters Parameter
Type
Description
files
Array of objects
Definition
Indicates the list of backup files.
For details, see Table 3.
bucket
String
Definition
Indicates the name of the bucket where the file is located.
Range
N/A
Table 3 files field data structure description Parameter
Type
Description
name
String
Definition
Indicates the file name.
Range
N/A
size
Long
Definition
Indicates the file size in KB.
Range
N/A
download_link
String
Definition
Indicates the link for downloading the backup file.
Range
N/A
link_expired_time
String
Definition
Indicates the link expiration time. The format is "yyyy-mm-ddThh:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
Range
N/A
- Example normal response
{ "files": [ { "name": "43e4feaab48f11e89039fa163ebaa7e4br01.xxx", "size": 2803, "download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "link_expired_time":"2018-08-016T10:15:14+0800" } ], "bucket": "rdsbucket.bucketname" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.