更新时间:2025-12-18 GMT+08:00
分享

查询配额(1.0.0)-ListQuotas2

功能介绍

查询租户配额。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/graphs/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目编号。获取方法,请参见获取项目ID。

约束限制:

不涉及。

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

quotas

quotas Object

参数解释:

GES资源配额。

取值范围:

不涉及。

表4 quotas

参数

参数类型

描述

resources

Array of resources objects

参数解释:

GES资源配额列表。

取值范围:

不涉及。

表5 resources

参数

参数类型

描述

type

String

参数解释:

GES资源类型。

取值范围:

  • graph:图。
  • backup:备份。
  • metadata:元数据。

available

Integer

参数解释:

GES资源可用数量。

当available参数值为-1时,表示图的可用个数不限制。

取值范围:

不涉及。

edge_volume

Integer

参数解释:

边的可用个数。type(配额类型)取值为graph时此值有效。

当edgeVolume参数值为-1时,表示边的可用个数不限制。

取值范围:

不涉及。

状态码: 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

服务不可用

错误码

请参见错误码。

相关文档