查询智能体优化任务列表 - ListOpsAgentTuningTasks
功能介绍
本接口用于查询当前租户下的智能体优化任务列表,支持通过任务名称、任务类型和任务状态进行过滤,并支持分页功能。同时,响应中会返回全局状态的分组统计信息。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET https://agentarts.region_id.myhuaweicloud.com/v1/ops/agent-tuning-tasks
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 满足过滤条件的记录总数,用于计算分页总页数。 取值范围: 0-100的整数。 |
| status_count | 参数解释: 各状态下的任务统计数据。 取值范围: 不涉及。 | |
| tasks | Array of OpsAgentTuningTaskListInfo objects | 参数解释: 任务列表,表示当前分页下的任务详情列表,符合OpsAgentTuningTask定义的对象数组。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| draft | Integer | 参数解释: 草稿任务个数。 取值范围: 0-1000的整数。 |
| running | Integer | 参数解释: 运行中任务个数。 取值范围: 0-1000的整数。 |
| stopped | Integer | 参数解释: 已停止任务个数。 取值范围: 0-1000的整数。 |
| success | Integer | 参数解释: 成功任务个数。 取值范围: 0-1000的整数。 |
| fail | Integer | 参数解释: 失败任务个数。 取值范围: 0-1000的整数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 智能体优化任务ID。 取值范围: UUID格式字符串。 |
| name | String | 参数解释: 任务名称。 取值范围: 长度1-64个字符的字符串。 |
| description | String | 参数解释: 任务描述。 取值范围: 长度0-255个字符的字符串。 |
| type | String | 参数解释: 任务类型,用于根据类型筛选任务。 取值范围: tool:工具,skill:技能。 |
| agent | OpsAgentTuningTaskAgent object | 参数解释: 智能体优化任务智能体。 取值范围: 不涉及。 |
| agency_name | String | 参数解释: 委托名称,赋予服务访问用户资源的权限。 取值范围: 有效的IAM委托名称字符串。 |
| analysis_task_id | String | 参数解释: 分析任务ID,通过分析任务一键优化创建出来的智能体优化任务该字段不为空。 取值范围: 有效分析任务ID。 |
| status | String | 参数解释: 任务状态。 取值范围: draft:草稿态,running:运行中,stopping:停止中,stopped:已停止,success:成功,fail:失败。 |
| fail_reason | String | 参数解释: 失败的错误信息。 取值范围: 无。 |
| created_at | Long | 参数解释: 创建时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳,最小值0,最大值9223372036854775807。 |
| updated_at | Long | 参数解释: 更新时间(单位:毫秒)。 取值范围: 13位毫秒级时间戳,最小值0,最大值9223372036854775807。 |
| executed_at | Long | 参数解释: 执行时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳,最小值0,最大值9223372036854775807。 |
| end_at | Long | 参数解释: 执行结束时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳,最小值0,最大值9223372036854775807。 |
| executed_time | Integer | 参数解释: 运行时长,单位:分钟。 取值范围: 大于等于0的整数(单位:分钟) |
| end_at | Long | 参数解释: 执行结束时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳,最小值0,最大值9223372036854775807。 |
| executed_time | Integer | 参数解释: 运行时长,单位:分钟。 取值范围: 大于等于0的整数(单位:分钟) |
| tags | Array of OpsTasksTagForTMS objects | 参数解释: 资源标签列表。 取值范围: 符合OpsTasksTagForTMS定义的对象数组。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释: 智能体类型。 取值范围: agent:单智能体,workflow:工作流,agentrun:部署在运行时的智能体,third_party:三方接入观测的智能体。 |
| id | String | 参数解释: 智能体ID,对应AgentArts平台中的智能体实例。 可在AgentArts平台“开发中心 > 智能体管理”页面获取ID,注意对应的智能体需要是“已提交”状态。 取值范围: 有效标识符字符串,最小长度0,最大长度64。 |
| agent_type | String | 参数解释: 观测侧智能体资源类型,agentrun/third_party类型的智能体对应观测侧agent/multiagents/workflow,用于数据面按观测侧resource_type查询轨迹。 取值范围: agent:单智能体,multiagents:多智能体,workflow:工作流。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键,标识资源的分类维度。 取值范围: 最大长度128个unicode字符。 |
| value | String | 参数解释: 标签值,具体的分类值。 取值范围: 不校验字符集范围。每个值最大长度255个unicode字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:机器可读的错误代码。 取值范围:系统错误码字符串。 |
| error_msg | String | 参数解释:人类可读的错误消息。 取值范围:详细错误说明字符串。 |
| encoded_authorization_message | String | 参数解释:编码后的授权失败信息。 取值范围:字符串。 |
| details | Array of OpsRLCommonError objects | 参数解释:依赖的下游服务错误信息列表。 取值范围:包含error_code和error_msg的对象数组。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
请求示例
查询当前租户下的智能体优化任务列表,支持通过任务名称和任务状态进行过滤,并支持分页功能。
GET /v1/ops/agent-tuning-tasks?offset=0&limit=10&name=test&status=training
响应示例
状态码:200
{
"total" : 1,
"status_count" : {
"draft" : 0,
"running" : 1,
"stopped" : 0,
"success" : 0,
"fail" : 0
},
"tasks" : [ {
"id" : "57ae91cf2f504899921a50d1c75f0547",
"name" : "test",
"description" : "这是一个测试智能体优化任务",
"agent" : {
"type" : "agent",
"id" : "f0fab58d-8285-4c47-b856-1079cad579da"
},
"agency_name" : "ops-tuning-agency",
"status" : "running",
"created_at" : 1744214400000,
"updated_at" : 1744218000000,
"executed_time" : 60,
"tags" : [ {
"key" : "project",
"value" : "ops-demo"
} ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 任务列表数据。 |
| 400 | 无效的请求参数。 |
| 403 | 权限不足,拒绝访问。 |
| 429 | 请求频率超限。 |
| 500 | 内部服务器错误。 |
错误码
请参见错误码。