A200161411/cloud-container-engine

proposalbot 2490522af3 Changes to cce_api-ref from docs/doc-exports#318 (CCE API for v1.23

CCE API for

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

2022-11-10 10:54:32 +00:00

6.7 KiB

Raw Blame History

original_name: ShowQuotas.html

Querying Resource Quotas

Function

This API is used to query CCE resource quotas.

URI

GET /api/v3/projects/{project_id}/quotas

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see `How to Obtain Parameters in the API URI <cce_02_0271>`.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default: application/json
X-Auth-Token	Yes	String	Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. Maximum: 16384

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
quotas	Array of `QuotaResource <showquotas__en-us_topic_0000001242535373_response_quotaresource>` objects	Resources

**Table 4** QuotaResource
Parameter	Type	Description
quotaKey	String	Resource type
quotaLimit	Integer	Quota
used	Integer	Number of created resources
unit	String	Unit
regionId	String	Region ID. This parameter is not returned if not involved.
availabilityZoneId	String	AZ ID. This parameter is not returned if not involved.

Example Requests

None

Example Responses

Status code: 200

The resource quotas are obtained successfully.

{
  "quotas" : {
    "resources" : [ {
      "quotaKey" : "cluster",
      "quotaLimit" : 20,
      "used" : 13,
      "unit" : "count"
    } ]
  }
}

Status Codes

Status Code	Description
200	The resource quotas are obtained successfully.

Error Codes

See Error Codes <cce_02_0250>.

6.7 KiB Raw Blame History