Obtaining Quota Information

Function

This API is used to obtain UCS quota information.

URI

GET /v1/maintenance/quota/{domainid}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domainid	Yes	String	Domain ID

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
quotas	CommonQuotas object	Quota set

**Table 3** CommonQuotas
Parameter	Type	Description
resources	Array of QuotaResource objects	List of resources that have quotas

**Table 4** QuotaResource
Parameter	Type	Description
type	String	Quota type. Options: cluster: cluster quota clustergroup: fleet quota rule: rule quota federation: federation quota
quota	String	Total quota
used	String	Used quota
unit	String	Unit
min	String	Minimum value
max	String	Maximum value

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
-	String	-

Example Requests

None

Example Responses

Status code: 200

Quota information of the current tenant returned

{
  "quotas" : {
    "resources" : [ {
      "type" : "cluster",
      "quota" : 75,
      "used" : 8,
      "unit" : "",
      "min" : 20,
      "max" : 100
    }, {
      "type" : "clustergroup",
      "quota" : 50,
      "used" : 2,
      "unit" : "",
      "min" : 20,
      "max" : 100
    }, {
      "type" : "rule",
      "quota" : 50,
      "used" : 1,
      "unit" : "",
      "min" : 20,
      "max" : 100
    }, {
      "type" : "federation",
      "quota" : 10,
      "used" : 1,
      "unit" : "",
      "min" : 1,
      "max" : 50
    } ]
  }
}

Status Codes

Status Code	Description
200	Quota information of the current tenant returned
400	Client request error. The server could not execute the request.
403	The server refused the request.
500	Internal server error