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.

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 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.

last updated: 2024-05-07 02:04