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

Querying the Instance Quotas of a Tenant

Function

This API is used to modify the resource quotas of a specified enterprise project. Before calling this API:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying the Instance Quotas of a Tenant) before then.

URI

GET /mysql/v3/{project_id}/project-quotas

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain this value, see Obtaining a Project ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

No

String

Resource type used to filter quotas.

Its value can be instance.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

X-Language

No

String

Language.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

quotas

Object

Tenant instance quota information.
Table 5 project-quotas

Parameter

Type

Description

resources

Array of objects

Resource list objects.
Table 6 resource

Parameter

Type

Description

type

String

Quota of the specified type.

The value is instance, which indicates the instance quota.

used

Integer

Number of created resources.

quota

Integer

Maximum resource quota.

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

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

Example Response

Status code: 200

Success.

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

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Quota Management