获取当前项目的配额 - ShowOpsQuota
功能介绍
该接口用于获取当前项目的配额信息,支持查询各类任务的数量上限和剩余配额,适用于资源管理和容量规划的场景。
适用场景:
URI
GET /v1/ops/quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_type |
否 |
String |
参数解释: 任务的类型分类标识。该参数用于在查询列表时进行过滤,以便区分并获取特定类别的任务(例如:评估任务、数据合成任务等)。 约束限制: 字符串长度为0到1,200。 取值范围: 0-1200字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json |
|
Authorization |
是 |
String |
参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Sdk-Date |
是 |
String |
参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
quotas |
Array of QuotaItem objects |
参数解释: 当前项目下的任务配额信息列表。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_type |
String |
参数解释: 任务的类型分类。 约束限制: 长度为0到10000个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
total_task_count |
Long |
参数解释: 当前已消耗的任务总数。 约束限制: 0到int64 最大值。 取值范围: 0到9223372036854775807。 默认取值: 0。 |
|
free_task_quota_limit |
Long |
参数解释: 免费任务的配额上限。 约束限制: 0到int64 最大值。 取值范围: 0到9223372036854775807。 默认取值: 0。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
|
error_msg |
String |
参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 任意文本内容。 |
请求示例
请求获取当前项目的配额信息
GET https://*.com/agentarts/v1/ops/quotas
响应示例
状态码:200
查询成功
{
"quotas" : [ {
"task_type" : "evaluation",
"total_task_count" : 10,
"free_task_quota_limit" : 10
} ]
}
状态码:400
错误请求
{
"error_code" : "AgentArts.03400001",
"error_msg" : "请求错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功 |
|
400 |
错误请求 |
错误码
请参见错误码。