Obtaining the Link for Downloading a Backup File

Function

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

Constraints

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

URI

URI format
GET /v3/{project_id}/backups/download-file
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.

**Table 1** Path parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	String	path	Definition Project ID. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Name	Mandatory	Type	IN	Description
instance_id	Yes	String	path	Definition 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. Constraints N/A Range N/A Default Value N/A
backup_id	Yes	String	query	Definition Backup ID. Constraints N/A Range N/A Default Value N/A

Request parameters

**Table 3** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	String	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	header	Definition Language. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 4** Response body parameters
Name	Mandatory	Type	Description
files	Yes	Array of objects	Definition The list of backup files. For more information, see Table 5. Range N/A
bucket	Yes	String	Definition The name of the bucket where the file is located. Range N/A

**Table 5** Data structure description of the files field
Name	Mandatory	Type	Description
name	Yes	String	Definition File name. Range N/A
size	Yes	Long	Definition Indicates the file size in KB. Range N/A
download_link	Yes	String	Definition The link for downloading the backup file. Range N/A
link_expired_time	Yes	String	Definition 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. Range N/A

Example Requests

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/download-file?instance_id=befb1cfe1f96403780396b0c54f85d11in02&backup_id=bd062e1af2d248b3bb4cd3dbb4183888br02

Example Responses

{
   "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.