Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Querying Backup Resource Package Specifications
Updated on 2026-06-12 GMT+08:00

Querying Backup Resource Package Specifications

Function

The API is used to query available specifications for a yearly/monthly backup resource package. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:backup:listResourcePackageFlavor

    List

    -

    -

    gaussdb:backup:listResourcePackageFlavor

    -

URI

GET /v3/{project_id}/backups/resource-package/flavors

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints

The value must be an integer and cannot be a negative number.

Range

≥ 0

Default Value

0

limit

No

Integer

Definition

Number of records returned by a query.

Constraints

The value must be an integer and cannot be a negative number.

Range

1–100

Default Value

100

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English

  • zh-cn: Chinese

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

flavors

Array of BackupResourcePackageFlavor objects

Definition

List of available backup resource package specifications.

Table 5 BackupResourcePackageFlavor

Parameter

Type

Description

spec_code

String

Definition

Backup resource package specification code.

Range

N/A

volume

String

Definition

Backup resource package specifications.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying available backup resource package specifications

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/resource-package/flavors

Example Response

Status code: 200

Success.

Querying available backup resource package specifications

{
  "flavors" : [ {
    "spec_code" : "gaussdb.mysql.backup.pkg.1tb",
    "volume" : "1TB"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.