Help Center/ GaussDB/ API Reference/ APIs/ Quota Management/ Obtaining Quota Information
Updated on 2026-09-24 GMT+08:00

Obtaining Quota Information

Function

This API is used to obtain quota information. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/quotas

Table 1 URI parameters

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language of the information returned by the API.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

quotas

InstanceQuotaResult object

Definition

Project resource quota details.

Table 4 InstanceQuotaResult

Parameter

Type

Description

resources

Array of InstanceResourceQuotaResult objects

Definition

Project resource quota list.

Table 5 InstanceResourceQuotaResult

Parameter

Type

Description

type

String

Definition

Resource type.

Range

instance: instance resources

quota

Integer

Definition

Total resource quota.

Range

N/A

used

Integer

Definition

Used resource quota.

Range

N/A

Example Request

Obtaining quota information

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/quotas

Example Response

Quota information returned.

{
  "quotas" : {
    "resources" : [ {
      "type" : "instance",
      "quota" : 6000,
      "used" : 1
    } ]
  }
}

Status Codes

Error Codes

For details, see Error Codes.