Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Quota Management/ Querying the Instance Quotas of a Tenant
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Instance Quotas of a Tenant

Function

This API is used to query the resource quotas of a specified tenant. 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 Policies 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:quota:list

    Read

    -

    -

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/project-quotas

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 parameter

Parameter

Mandatory

Type

Description

type

No

String

Definition

Resource type used to filter quotas.

Constraints

N/A

Range

instance: instance type

Default Value

instance

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
  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

quotas

project-quotas object

Definition

Instance quota of a tenant.
Table 5 project-quotas

Parameter

Type

Description

resources

Array of resource objects

Definition

Resource objects.
Table 6 resource

Parameter

Type

Description

type

String

Definition

Quota of a specified type.

Range

instance: instance type

used

Integer

Definition

Number of created resources.

Range

≥ 0

quota

Integer

Definition

Maximum resource quota.

Range

The instance quantity quota ranges from 0 to 100,000. The value -1 indicates no limit.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the instance quotas of a tenant

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance

Example Response

Status code: 200

Success.

{
  "quotas" : {
    "resources" : [ {
      "type" : "instance,",
      "used" : "4,",
      "quota" : 50
    } ]
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Quota Management