Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>

2024-07-04 11:26:33 +00:00

10 KiB

Raw Blame History

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	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Request Parameters

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

Response Parameters

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.

Example Requests

URI example

GET https://{Endpoint}/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

10 KiB Raw Blame History