Obtaining the Link for Downloading a Backup File

Function

This API is used to obtain the link for downloading a backup file.

Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.

Constraints

This API is used to query full and incremental backups of MySQL and PostgreSQL databases.

URI

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

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
backup_id	Yes	Specifies the backup ID.

Request

None

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
files	Array of objects	Indicates the list of backup files. For details, see Table 3.
bucket	String	Indicates the name of the bucket where the file is located.

**Table 3** files field data structure description
Name	Type	Description
name	String	Indicates the file name.
size	Long	Indicates the file size in KB.
download_link	String	Indicates the link for downloading the backup file.
link_expired_time	String	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 +0000.

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+0000"
     }
     ],
    "bucket": "rdsbucket.bucketname"
}