Updated on 2025-08-18 GMT+08:00

Obtaining the Link for Downloading a Backup File

Function

This API is used to obtain the link for downloading a backup file. Before calling this API:

Learn how to authenticate this API.

Constraints

This API is used to obtain the links for downloading manual and automated full backups of GaussDB.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
backup_id	Yes	String	Backup ID, which is compliant with the UUID format.

Request Parameters

None

Response Parameters

**Table 2** Response body parameters
Name	Type	Mandatory	Description
files	Array of Table 3	Yes	Backup file information.
bucket	String	Yes	Name of the bucket where the file is located.

**Table 3** files
Name	Type	Mandatory	Description
name	String	Yes	File name.
size	Long	Yes	File size, in KB.
download_link	String	Yes	Link for downloading the backup file.
link_expired_time	String	Yes	Link expiration time. The format is "yyyy-mm-ddThh:mm:ssZ". T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

**Table 4** Response body parameters
Name	Type	Mandatory	Description
error_code	String	Yes	Error code.
error_msg	String	Yes	Error message.

Example Request

Obtaining the link for downloading a backup file

https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/backup-files/e28d08754b1a490fb2b3540ed013a7fbbr14?backup_id=2f4ddb93b9014b0893d81d2e472f30febr14

Example Response

Status code 200

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

Status code default

{ 
    "error_code":"DBS.200022", 
"error_msg": "Failed to obtain the download link of a backup file."
}

Status Code

Normal
200
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup and Restoration