• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Backup and Restoration
  6. Obtaining the Link for Downloading a Backup File

Obtaining the Link for Downloading a Backup File

Function

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

URI

  • URI format

    PATH: /{version_id}/{project_id}/backup-files?backup_id={backup_id}

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    version_id

    Yes

    Specifies the API version. It is case-sensitive and the value is v3.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    backup_id

    Yes

    Specifies the backup ID.

  • Restrictions

    This API is used to download full backups of MySQL, PostgreSQL, and Microsoft SQL Server databases and incremental backups of MySQL databases.

Example

GET /v3/97b026aa9cc4417888c14c84a1ad9860/backup-files?backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01

Request

N/A

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    files

    List data structure

    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_link

    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 +0800.

  • Response example
    {
       "files": [
        {
            "name": "43e4feaab48f11e89039fa163ebaa7e4br01.xxx",
            "size": 2803,
            "download_link":"https://obs.myhwclouds.com/rdsbucket.southchina.user.2/xxxxxx",
            "link_expired_time":"2018-08-016T10:15:14+0800"
         }, 
         {
            "name":"43e4feaab48f11e89039fa163ebaa7e4br01.xxx",
            "size": 2803,
            "download_link":"https://obs.myhwclouds.com/rdsbucket.southchina.user.2/xxxxxx",
            "link_expired_time":"2018-08-016T10:15:14+0800"
         }
         ],
        "bucket": "rdsbucket.op.svc.rds.1024.cn.north.1"
    }