Querying Quotas (1.0.0)

Function

This API is used to query the tenant quotas.

URI

GET /v2/{project_id}/graphs/quotas

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
quotas	quotas Object	Definition GES resource quota. Range N/A

**Table 4** quotas
Parameter	Type	Description
resources	Array of resources objects	Definition GES resource quota list. Range N/A

**Table 5** resources
Parameter	Type	Description
type	String	Definition GES resource type. Range graph backup metadata
available	Integer	Definition Number of available GES graphs. When the value is -1, the number of available graphs is unlimited. Range N/A
edge_volume	Integer	Definition Number of available edges. This parameter is returned only when type is graph. When the value is -1, the number of available edges is unlimited. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition System prompt code. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A

Example Request

Query tenant quotas.

GET https://{Endpoint}/v2/{project_id}/graphs/quotas

Example Response

Status code: 200

Example response for a successful request

{
  "quotas" : {
    "resources" : [ {
      "type" : "graph",
      "available" : 10,
      "edge_volume" : 7300
    }, {
      "type" : "backup",
      "available" : 100
    }, {
      "type" : "metadata",
      "available" : 86
    } ]
  }
}

Status code: 400

Example response for a failed request

{
  "error_code" : "GES.7006",
  "error_msg" : "An internal error occurs in the underlying service of the graph engine."
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.