Querying Quota¶

Function¶

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

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

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
quotas	ShowResourcesListResponseBody object	Quota information.

**Table 4** ShowResourcesListResponseBody¶
Parameter	Type	Description
resources	Array of ShowResourcesDetailResponseBody objects	All resources.

**Table 5** ShowResourcesDetailResponseBody¶
Parameter	Type	Description
type	String	Quota resource type. Only the instance type is supported.
quota	Integer	Current quota. If this parameter is set to 0, no quantity limit is set for resources.
used	Integer	Number of used resources.

URI example

GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/quotas

Status code: 200

Success

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

For details, see Status Codes.

For details, see Error Codes.

last updated: 2024-12-10 15:07 UTC - commit: cf50b08f82e58871085516460cdd259d578714fa