查询配额维度的免费配额和总配额信息 - ShowOpsEvaluationQuota
功能介绍
该接口用于查询配额维度的免费配额和总配额信息。
适用场景:
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
GET /v1/ops/evaluation-quotas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 否 | String | 参数解释: 配额类型: 约束限制: 不涉及。 取值范围: evaluation_task_count, parallel_online_evaluation_task_count, synthesis_task_count, parallel_synthesis_task_count, dataset_count, evaluator_count, label_count。 不传该参数时返回所有配额类型。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of OpsEvaluationQuotaResponse objects | 参数解释: 查询指定配额维度的免费配额和总配额信息的响应体。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释: 配额维度标识。取值范围:evaluation_task_count, parallel_online_evaluation_task_count, synthesis_task_count, parallel_synthesis_task_count, dataset_count, evaluator_count, label_count。 |
| free_quota_limit | Long | 参数解释: 免费配额上限。仅evaluation_task_count和synthesis_task_count有值,其他维度返回null。 |
| free_used | Long | 参数解释: 免费配额已用数量。仅evaluation_task_count和synthesis_task_count有值,其他维度返回null。 |
| total_quota_limit | Long | 参数解释: 总配额上限,从ServiceCM平台获取。 |
| total_used_count | Long | 参数解释: 总配额已用数量,统计未删除状态的数据。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
请求示例
查询评测任务配额维度的免费配额和总配额信息
GET https://api.example.com/v1/ops/evaluation-quotas?type=evaluation_task_count
响应示例
状态码:200
查询成功
[ {
"type" : "evaluation_task_count",
"free_quota_limit" : 10,
"free_used" : 5,
"total_quota_limit" : 1000,
"total_used_count" : 50
} ] 状态码:400
请求参数错误
{
"error_code" : "AgentArts.10004001",
"error_msg" : "file_suffix is required"
} 状态码:429
请求过于频繁
{
"error_code" : "AgentArts.100004290",
"error_msg" : "请求过于频繁"
} 状态码:500
系统错误
{
"error_code" : "AgentArts.03500001",
"error_msg" : "internal error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 请求参数错误 |
| 429 | 请求过于频繁 |
| 500 | 系统错误 |
错误码
请参见错误码。