文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 全局配置API/ 查询配额信息
更新时间：2022-04-25 GMT+08:00
查看PDF
分享

查询配额信息

功能介绍

该接口用于查询配额管理信息。

URI

GET /v1/{project_id}/quota?type={type}

参数说明请参见表1-URI参数说明。
表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

type

是

String

指定需要查询配额的资源类型，可选值为“infer_service”、“infer_flow”。

请求消息

请求参数暂不涉及。

响应消息

响应参数请参见表2。

表2 响应参数说明

参数名称

参数类型

说明

is_success

Boolean

请求是否成功。

quotas

object

请参见表3。

error_code

String

请求失败时的错误码，请求成功时无此字段。

error_msg

String

请求失败时的错误信息，请求成功时无此字段。
表3 quotas参数说明

参数名称

参数类型

说明

resources

List<Resource>

请参见表4 Resource响应参数说明。
表4 Resource响应参数说明

参数名称

参数类型

说明

type

Boolean

资源类型。

quota

String

配额信息。

unit

String

配额信息对应的单位。

min

Integer

最小配额。

max

Integer

最大配额。

used

Integer

已经使用的配额信息。

示例

  • 成功响应示例 
    {
    "is_success": true,
    "quotas": {
        "resources": [
            {
                "type": "infer_service",
                "quota": "9",
                "unit": "个",
                "min": 1,
                "max": 100,
                "used": 9
            }
        ]
    }
}
  • 失败响应示例 
    {
    "is_success": false,
    "error_code": "res.8004",
    "error_msg": "Default quota(infer_service) is null."
}

状态码

状态码请参见状态码。

父主题： 全局配置API

相关文档