Obtaining the Link for Downloading a Backup File

Description

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

Restrictions

The backup download link is valid within 15 minutes after being updated.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/backups/download-file?instance_id={instance_id}&backup_id={backup_id}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups/download-file?instance_id=befb1cfe1f96403780396b0c54f85d11in02&backup_id=bd062e1af2d248b3bb4cd3dbb4183888br02

You can obtain a backup ID from the API in Querying the Backup List.

Requests

Parameter description

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	String	header	Yes	User token obtained from IAM. For details, see Authentication.
X-Language	String	header	No	Language
project_id	String	path	Yes	Project ID. To obtain the project ID, see Obtaining a Project ID.
instance_id	String	path	Yes	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.
backup_id	String	query	Yes	Backup ID.

Responses

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
files	Array of objects	Yes	The list of backup files. For more information, see Table 3.
bucket	String	Yes	The name of the bucket where the file is located.

**Table 3** Data structure description of the files field
Name	Type	Mandatory	Description
name	String	Yes	File name.
size	Long	Yes	Indicates the file size in KB.
download_link	String	Yes	The link for downloading the backup file.
link_expired_time	String	Yes	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, the time zone offset of UTC is shown as +0000.

Response example

{
   "files": [
    {
        "name": "43e4feaab48f11e89039fa163ebaa7e4br02.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"
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.