Querying Quotas

Function

This API is used to query tenant quotas.

URI

GET /v1.0/{project_id}/graphs/quotas

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Used to obtain the permission to use APIs. For details about how to obtain the token, see Authentication of Management Plane APIs. The value of X-Subject-Token in the response header is the token.

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
quotas	GesQuotaResp object	Resource type list. This field is left blank when the request fails.

**Table 4** GesQuotaResp
Parameter	Type	Description
resources	Array of Quota objects	GES resource quota list

**Table 5** Quota
Parameter	Type	Description
type	String	Quota type. Available values are as follows: "graph" "backup" "metadata"
available	Integer	Number of available graphs
edgeVolume	Integer	Number of available edges. This parameter is available only when type is graph.

Example Request

GET https://Endpoint/v1.0/{project_id}/graphs/quotas

Example Response

Status code: 200

{
  "quotas" : {
    "resources" : [ {
      "type" : "graph",
      "available" : 1,
      "edgeVolume" : 178800
    }, {
      "type" : "backup",
      "available" : 7
    }, {
      "type" : "metadata",
      "available" : 13
    } ]
  }
}

Status Codes

Status Code	Description
200	Request sent.
400	Request error.
401	Authorization failed.
403	No operation permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.