Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Quota Management/ Querying the Instance Quotas of a Tenant
Updated on 2024-09-11 GMT+08:00

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:

URI

GET /v3/{project_id}/project-quotas

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

None

Value range:

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

Default value:

None

Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

No

String

Explanation:

Resource type used to filter quotas.

Constraints:

None

Value range:

instance

Default value:

instance

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token.

It can be obtained by calling the IAM API used to obtain a user token.

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

Constraints:

None

Value range:

None

Default value:

None

X-Language

No

String

Explanation:

Request language type.

Constraints:

None

Value 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

Explanation:

Instance quota of a tenant.

Table 5 project-quotas

Parameter

Type

Description

resources

Array of resource objects

Explanation:

Resource objects.

Table 6 resource

Parameter

Type

Description

type

String

Explanation:

Quota of a specified type.

Value range:

instance

used

Integer

Explanation:

Number of created resources.

Value range:

≥ 0

quota

Integer

Explanation:

Maximum resource quota.

Value 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.