Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Quotas/ Querying Quota
Updated on 2025-09-04 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 URI parameter

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

datastore_type

No

String

Explanation:

Database type

Constraints:

N/A

Values:

  • cassandra: GeminiDB Cassandra instance quotas are queried.
  • mongodb: GeminiDB Mongo instance quotas are queried.
  • influxdb: GeminiDB Influx instance quotas are queried.
  • redis: GeminiDB Redis instance quotas are queried.

Default value:

If this parameter is not transferred, all instance quotas are queried.

mode

No

String

Explanation:

Instance type

Constraints:

N/A

Values:

  • Cluster: proxy cluster GeminiDB Redis instance; cluster GeminiDB Cassandra or Influx instance with classic storage
  • CloudNativeCluster: cluster GeminiDB Cassandra, Influx, or Redis instance with cloud native storage
  • RedisCluster: Redis Cluster GeminiDB Redis instance with classic storage
  • Replication: primary/standby GeminiDB Redis instance with classic storage
  • InfluxdbSingle: single-node GeminiDB Influx instance with classic storage
  • ReplicaSet: GeminiDB Mongo instance in a replica set

Default value:

If datastore_type is not transferred, this parameter is automatically ignored. This parameter is mandatory when datastore_type is transferred.

product_type

No

String

Explanation:

Product type

Constraints:

N/A

Values:

  • Capacity
  • Standard
  • This parameter is mandatory when quotas of GeminiDB Redis instances with cloud native storage need to be queried.

Default value:

N/A

Request Parameters

Table 3 Request header parameter

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 4 Response body parameter

Parameter

Type

Description

quotas

ShowResourcesListResponseBody object

Explanation:

Quota information.
Table 5 ShowResourcesListResponseBody

Parameter

Type

Description

resources

Array of ShowResourcesDetailResponseBody objects

Explanation:

All resources.
Table 6 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 Request

URI example 
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/quotas?mode=InfluxdbSingle&datastore_type=influxdb

Example Response

Status code: 200

Successful request

{
  "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