Help Center> Graph Engine Service> API Reference> Management Plane APIs> System Management APIs> Viewing Quotas (1.0.0)
View PDF

Viewing Quotas (1.0.0)

Function

This API is used to query tenant quotas.

URI

  • URI format 
    GET /v1.0/{project_id}/graphs/quotas
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation

Request

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

Response

Table 2 Parameter description

Parameter

Mandatory

Type

Description

errorMessage

No

String

System prompt. If execution succeeds, this parameter is left blank. If execution fails, this parameter is used to display the error message.

errorCode

No

String

System prompt. If execution succeeds, this parameter is left blank. If execution fails, this parameter is used to display the error code.

quotas

No

GesQuotaResp

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

GES quota list.
Table 3 GesQuotaResp type

Parameter

Mandatory

Type

Description

resources

Yes

List<Quota>

GES resource quota list
Table 4 Quota type

Parameter

Mandatory

Type

Description

type

Yes

String

Resource type.

Possible values:

  • graph
  • backup
  • metadata

available

Yes

Integer

Number of available graphs

edgeVolume

No

Integer

Number of available edges. The parameter value is valid only when type is graph.
  • Response example (successful request) 
    Http Status Code: 200
{   "quotas": {
       "resources": [
           {
               "type": "graph",
               "available": 1,
               "edgeVolume": 178800
           },
           {
               "type": "backup",
               "available": 7
           },
           {
               "type": "metadata",
               "available": 13
           }
       ]
   }
 }
  • Response example (failed request) 
    Http Status: 400
{
   "errorCode": "GES.7006",
   "errorMessage": "The underlying graph engine has internal error."
}

Return Value

  • Normal

    200

  • Abnormal
    Table 5 Return code for failed requests

    Return Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    No operation permission.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    Service unavailable.
Parent topic: System Management APIs