Querying Quota

Function

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

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

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	Dependencies
gaussdbfornosql::listResourceQuota	Read	-	-	nosql:instance:list	-

URI

GET /v3/{project_id}/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 N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
datastore_type	No	String	Definition Database type Constraints N/A Range 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	Definition Instance type Constraints N/A Range 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 EnhancedCluster: GeminiDB Influx cluster (performance-enhanced) 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	Definition Product type Constraints N/A Range Capacity Standard Performance: performance-enhanced This parameter is mandatory when you query a GeminiDB Redis cluster instance with cloud native storage. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
quotas	ShowResourcesListResponseBody object	Definition Quota information.

**Table 5** ShowResourcesListResponseBody
Parameter	Type	Description
resources	Array of ShowResourcesDetailResponseBody objects	Definition All resources.

**Table 6** ShowResourcesDetailResponseBody
Parameter	Type	Description
type	String	Definition Quota resource type Constraints This parameter is configured only by instance type. Range N/A
quota	Integer	Definition Current quota. If this parameter is set to 0, no quantity limit is set for resources. Range N/A
used	Integer	Definition Number of used resources. Range N/A

Example Requests

URI example

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

Example Responses

Status code: 200

Successful response

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

Previous topic: Quotas

Next topic: Disaster Recovery

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot