文档首页/ 智果（AgentArts）智能体平台/ API参考/ API/ 评估/ 配额管理/ 获取当前项目的配额 - ShowOpsQuota
更新时间：2026-09-02 GMT+08:00
查看PDF
分享

获取当前项目的配额 - ShowOpsQuota

功能介绍

该接口用于获取当前项目的配额信息，支持查询各类任务的数量上限和剩余配额，适用于资源管理和容量规划的场景。

适用场景：

  • 任务创建前查询当前项目的资源限制和剩余容量，避免因配额不足导致任务创建失败。

  • 查看各类任务的已用配额和总量，掌握项目的资源消耗状况。

  • 当配额接近上限时，通过查询结果进行容量规划和预警。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

GET /v1/ops/quotas

表1 Query参数

参数

是否必选

参数类型

描述

task_type

否

String

参数解释：

任务的类型分类标识。该参数用于在查询列表时进行过滤，以便区分并获取特定类别的任务（例如：评估任务、数据合成任务等）。

约束限制：

字符串长度为0-1200。

取值范围：

0-1200字符。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

quotas

Array of OpsQuotaItem objects

参数解释：

当前项目下的任务配额信息列表。数组元素引用OpsQuotaItem对象。
表3 OpsQuotaItem

参数

参数类型

描述

task_type

String

参数解释：

任务的类型分类。

取值范围：

长度为0到10000个字符的字符串。

total_task_count

Long

参数解释：

当前已消耗的任务总数。

取值范围：

0到9223372036854775807之间的整数。

free_task_quota_limit

Long

参数解释：

免费任务的配额上限。

取值范围：

0到9223372036854775807之间的整数。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统定义的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对错误的详细描述，包含异常原因或解决建议。

取值范围：

字符长度2-512，任意文本内容。

encoded_authorization_message

String

参数解释：

编码后的授权信息，用于客户端解析权限问题。

取值范围：

Base64编码的字符串。

details

Array of OpsErrorDetail objects

参数解释：

错误详情列表，包含多个子错误的详细信息。

取值范围：

不涉及。

request_id

String

参数解释：

请求的唯一标识符，用于问题排查和链路追踪。

取值范围：

符合通用唯一识别码(UUID)标准的字符串。
表5 OpsErrorDetail

参数

参数类型

描述

error_code

String

参数解释：

子错误的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对子错误的详细描述。

取值范围：

任意文本内容。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统定义的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对错误的详细描述，包含异常原因或解决建议。

取值范围：

字符长度2-512，任意文本内容。

encoded_authorization_message

String

参数解释：

编码后的授权信息，用于客户端解析权限问题。

取值范围：

Base64编码的字符串。

details

Array of OpsErrorDetail objects

参数解释：

错误详情列表，包含多个子错误的详细信息。

取值范围：

不涉及。

request_id

String

参数解释：

请求的唯一标识符，用于问题排查和链路追踪。

取值范围：

符合通用唯一识别码(UUID)标准的字符串。
表7 OpsErrorDetail

参数

参数类型

描述

error_code

String

参数解释：

子错误的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对子错误的详细描述。

取值范围：

任意文本内容。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统定义的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对错误的详细描述，包含异常原因或解决建议。

取值范围：

字符长度2-512，任意文本内容。

encoded_authorization_message

String

参数解释：

编码后的授权信息，用于客户端解析权限问题。

取值范围：

Base64编码的字符串。

details

Array of OpsErrorDetail objects

参数解释：

错误详情列表，包含多个子错误的详细信息。

取值范围：

不涉及。

request_id

String

参数解释：

请求的唯一标识符，用于问题排查和链路追踪。

取值范围：

符合通用唯一识别码(UUID)标准的字符串。
表9 OpsErrorDetail

参数

参数类型

描述

error_code

String

参数解释：

子错误的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对子错误的详细描述。

取值范围：

任意文本内容。

状态码：429

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统定义的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对错误的详细描述，包含异常原因或解决建议。

取值范围：

字符长度2-512，任意文本内容。

encoded_authorization_message

String

参数解释：

编码后的授权信息，用于客户端解析权限问题。

取值范围：

Base64编码的字符串。

details

Array of OpsErrorDetail objects

参数解释：

错误详情列表，包含多个子错误的详细信息。

取值范围：

不涉及。

request_id

String

参数解释：

请求的唯一标识符，用于问题排查和链路追踪。

取值范围：

符合通用唯一识别码(UUID)标准的字符串。
表11 OpsErrorDetail

参数

参数类型

描述

error_code

String

参数解释：

子错误的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对子错误的详细描述。

取值范围：

任意文本内容。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统定义的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对错误的详细描述，包含异常原因或解决建议。

取值范围：

字符长度2-512，任意文本内容。

encoded_authorization_message

String

参数解释：

编码后的授权信息，用于客户端解析权限问题。

取值范围：

Base64编码的字符串。

details

Array of OpsErrorDetail objects

参数解释：

错误详情列表，包含多个子错误的详细信息。

取值范围：

不涉及。

request_id

String

参数解释：

请求的唯一标识符，用于问题排查和链路追踪。

取值范围：

符合通用唯一识别码(UUID)标准的字符串。
表13 OpsErrorDetail

参数

参数类型

描述

error_code

String

参数解释：

子错误的标准化错误代码。

取值范围：

业务异常编码字符串。

error_msg

String

参数解释：

对子错误的详细描述。

取值范围：

任意文本内容。

请求示例

请求获取当前项目的配额信息

GET https://api.example.com/v1/ops/quotas

响应示例

状态码：200

查询成功

{
  "quotas" : [ {
    "task_type" : "evaluation",
    "total_task_count" : 10,
    "free_task_quota_limit" : 10
  } ]
}

状态码：400

请求参数错误

{
  "error_code" : "AgentArts.10004001",
  "error_msg" : "file_suffix is required"
}

状态码：401

认证失败

{
  "error_code" : "AgentArts.100004010",
  "error_msg" : "unauthorized"
}

状态码：403

鉴权失败

{
  "error_code" : "AgentArts.100004030",
  "error_msg" : "forbidden"
}

状态码：429

请求过于频繁

{
  "error_code" : "AgentArts.100004290",
  "error_msg" : "请求过于频繁"
}

状态码：500

系统错误

{
  "error_code" : "AgentArts.03500001",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

查询成功

400

请求参数错误

401

认证失败

403

鉴权失败

429

请求过于频繁

500

系统错误

错误码

请参见错误码。

父主题： 配额管理

相关文档