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 backup or binlog backup of an RDS for MySQL instance, or the link for downloading a full backup or an incremental backup of an RDS for PostgreSQL or RDS for SQL Server instance.

URI

URI format
GET /v3/{project_id}/backup-files?backup_id={backup_id}

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. For details about how to obtain the backup ID, see Obtaining Backups. Constraints N/A Range N/A Default Value N/A

Request

Request parameters
None

URI example
GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backup-files?backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01

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. For example, in the Beijing time zone, the time zone offset is shown as +0800. Range N/A
database_name	String	Definition Indicates the name of the database. For RDS for SQL Server, the database name is returned if the backup file to be downloaded is a database-level backup. Otherwise, no value is returned. For other engines, if the backup file is not a database-level backup, no value is returned. 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",
        "database_name" : "rdsbucket"
     }
     ],
    "bucket": "rdsbucket.bucketname"
}