更新时间:2023-08-16 GMT+08:00

查询配额(1.0.0)

功能介绍

查询租户配额。

URI

GET /v2/{project_id}/graphs/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

quotas

quotas Object

resource类型列表,请求失败时该字段为空。

表4 quotas

参数

参数类型

描述

resources

Array of resources objects

GES资源配额列表。

表5 resources

参数

参数类型

描述

type

String

类型。

取值范围:

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

available

Integer

图的可用个数。

edge_volume

Integer

边的可用个数。type为graph时此值有效。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误信息。

error_msg

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

请求示例

查询租户配额。

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

响应示例

状态码: 200

成功响应示例

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

状态码: 400

失败响应示例

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

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码