Updated on 2024-01-04 GMT+08:00

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

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.

It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

quotas

quotas Object

Resource type list. This field is left blank when the request fails.

Table 4 quotas

Parameter

Type

Description

resources

Array of resources objects

GES resource quota list

Table 5 resources

Parameter

Type

Description

type

String

Quota type

Available values are as follows:

  • "graph"
  • "backup"
  • "metadata"

available

Integer

Number of available graphs

edge_volume

Integer

Number of available edges. The parameter value is valid only when type is graph.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error message.

error_msg

String

System prompt.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

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.

Error Codes

See Error Codes.