Obtaining Cluster Quotas

Function

This API is used to obtain the cluster quotas.

Calling Method

For details, see Calling APIs.

URI

GET /cce/v1/projects/{project_id}/quota

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Details: The request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) Default value: N/A
X-Auth-Token	Yes	String	Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
quotas	quotas object	Definition Cluster quota Constraints N/A

**Table 4** quotas
Parameter	Type	Description
resources	Array of ClusterQuotaResource objects	Definition Cluster quota Constraints N/A

**Table 5** ClusterQuotaResource
Parameter	Type	Description
type	String	Definition Resource type Constraints N/A Range cluster: a standard or Turbo cluster autopilot_cluster: an Autopilot cluster Default Value N/A
quota	Integer	Definition Total quota Constraints N/A Range N/A Default Value N/A
used	Integer	Definition Used resource quota Constraints N/A Range N/A Default Value N/A
unit	String	Definition Unit Constraints N/A Range N/A Default Value N/A
min	Integer	Definition Minimum quota Constraints N/A Range N/A Default Value N/A
max	Integer	Definition Maximum quota Constraints N/A Range N/A Default Value N/A

Example Requests

None

Example Responses

Status code: 200

The cluster quotas have been obtained.

{
  "quotas" : {
    "resources" : [ {
      "type" : "type",
      "quota" : 50,
      "used" : 23,
      "min" : 1,
      "max" : 1000,
      "unit" : "unit"
    } ]
  }
}