Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Backup and Restoration/ Authorizing Users to Download Backups
Updated on 2025-10-20 GMT+08:00

Authorizing Users to Download Backups

Function

This API is used to authorize users to download instance-level and table-level full and differential backups using OBS Browser+. Only backups stored in OBS can be downloaded. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/backups/{backup_id}/download/authorization

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

backup_id

Yes

String

Definition

Backup ID, which uniquely identifies a backup.

Constraints

N/A

Range

The value must be in UUID format, exactly 36 characters long, and contain only letters and digits.

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

bucket

String

Definition

Name of the bucket where the file is stored.

Range

N/A

file_paths

Array of Strings

Definition

Paths from which backups can be downloaded using OBS Browser+.

Example Request

Authorizing users to download backups

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups/e28d08754b1a490fb2b3540ed013a7fbbr14/download/authorization

Example Response

{
    "bucket": "bucketname",
    "file_paths": [
        "83dd054bbf784267a1dc1751bd09fec4_1de27464abdf48519f8574c97a8f0625in14/Db/1708145548040"
    ]
}

Status Codes

Error Codes

For details, see Error Codes.