Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Quotas/ Querying Quota
Updated on 2024-12-31 GMT+08:00
View PDF
Share

Querying Quota

Function

This API is used to query GeminiDB resource quotas of a tenant.

URI

GET https://{Endpoint}/v3/{project_id}/quotas

Table 1 Path 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:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

quotas

ShowResourcesListResponseBody object

Explanation:

Quota information.
Table 4 ShowResourcesListResponseBody

Parameter

Type

Description

resources

Array of ShowResourcesDetailResponseBody objects

Explanation:

All resources.
Table 5 ShowResourcesDetailResponseBody

Parameter

Type

Description

type

String

Explanation:

Quota resource type

Constraints:

This parameter is configured only by instance type.

Values:

N/A

quota

Integer

Explanation:

Current quota.

If this parameter is set to 0, no quantity limit is set for resources.

Values:

N/A

used

Integer

Explanation:

Number of used resources.

Values:

N/A

Example Requests

URI example 
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/quotas

Example Responses

Status code: 200

Success

{
  "quotas" : {
    "resources" : [ {
      "type" : "instance",
      "quota" : 200,
      "used" : 58
    } ]
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Quotas