Obtaining the Link for Downloading a Backup

Function

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

• Before calling an API, you need to understand the API in Authentication.
• 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 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
  backup_id	Yes	Explanation: Specifies the backup ID. Constraints: N/A Value 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 Parameter description

  Name	Type	Description
  files	Array of objects	Explanation: Indicates the list of backup files. For details, see Table 3.
  bucket	String	Explanation: Indicates the name of the bucket where the file is located. Value range: N/A

  Table 3 files field data structure description

  Name	Type	Description
  name	String	Explanation: Indicates the file name. Value range: N/A
  size	Long	Explanation: Indicates the file size in KB. Value range: N/A
  download_link	String	Explanation: Indicates the link for downloading the backup file. Value range: N/A
  link_expired_time	String	Explanation: 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. Value 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-16T10:15:14+0800"
       }
       ],
      "bucket": "rdsbucket.bucketname"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.