更新时间:2026-11-09 GMT+08:00
分享

查询分析任务列表 - ListOpsAnalysisTasks

功能介绍

本接口用于查询当前租户下的分析任务列表,支持通过任务名称、任务状态进行过滤,并支持分页功能。同时,响应中会返回全局状态的分组统计信息。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts:analysisTask:listOpsAnalysisTasks

List

analysisTask *

-

-

-

-

  • g:RequestTag/<tag-key>

  • g:TagKeys

URI

GET https://agentarts.region_id.myhuaweicloud.com/v1/ops/analysis-tasks

表1 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

索引位置偏移量,用于指定从第几条记录开始返回,单位:条(记录数)。

约束限制:

不涉及

取值范围:

大于等于0的整数。

默认取值:

0

limit

否

Integer

参数解释:

查询记录数,表示单页返回的最大任务数,单位:条。

约束限制:

不涉及

取值范围:

1到100的正整数。

默认取值:

无

name

否

String

参数解释:

任务名称,用于根据名称关键词筛选任务。

约束限制:

支持包含匹配的模糊搜索。

取值范围:

长度0-64个字符。

默认取值:

无

status

否

String

参数解释:

任务状态,用于根据状态筛选任务。

约束限制:

不涉及

取值范围:

draft:草稿态,scheduled:待运行,running:运行中,paused:已暂停,completed:已完成,fail:失败,stopping:停止中,stopped:已停止。

默认取值:

无

tag_key_exists

否

Array of strings

参数解释:

需要匹配的包含该标签名称的资源。

约束限制:

支持批量查询多个标签名,最多支持10个标签。

取值范围:

最小数量 0,最大数量 10

默认取值:

不涉及。

tag_key_matches

否

Array of strings

参数解释:

需要匹配的包含该标签的资源,需要和tag_value_matches条件配合使用,tag_key_matches和tag_value_matches的元素个数需要一致,且标签顺序需要完全匹配,不支持空字符串。

约束限制:

支持批量查询多个标签,最多支持10个标签。tag_key_matches和tag_value_matches键值对不可重复。

取值范围:

最小数量0,最大数量 10

默认取值:

不涉及。

tag_value_matches

否

Array of strings

参数解释:

需要匹配的包含该标签的资源,需要和tag_key_matches条件配合使用,tag_key_matches和tag_value_matches的元素个数需要一致,且标签顺序需要完全匹配,支持空字符串。

约束限制:

支持批量查询多个标签,最多支持10个标签。tag_key_matches和tag_value_matches键值对不可重复。

取值范围:

最小数量 0,最大数量 10

默认取值:

不涉及。

tag_match_policy

否

String

参数解释:

标签匹配模式,仅针对tag_key_exists,tag_key_matches,tag_value_matches参数生效。

  • ALL: 若请求中包含tag_key_exists参数,查询规则为资源标签需要包含tag_key_exists中的所有元素,若请求中tag_key_matches以及tag_value_matches参数存在,查询规则为资源标签需要包含所有tag_key_matches以及tag_value_matches参数中指定的key-value对应的标签。

  • ANY: 若请求中包含tag_key_exists参数,查询规则为资源标签需要包含tag_key_exists中的任意一个元素,若请求中tag_key_matches以及tag_value_matches参数存在,查询规则为资源标签需要包含tag_key_matches以及tag_value_matches参数中任意一个key-value对应的标签。

  • ALL

  • ANY

三个参数都存在时,取tag_key_exists和tag_key_matches,tag_value_matches的交集

三个参数都存在时,取tag_key_exists和tag_key_matches,tag_value_matches的并集。

约束限制:

不涉及。

取值范围:

长度为1-3个字符。允许的值为:

默认取值:

ALL

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

满足过滤条件的记录总数,用于计算分页总页数。

取值范围:

0-100的整数。

status_count

OpsAnalysisTaskStatusCount object

参数解释: 各个状态下的分析任务总数。

取值范围: 不涉及

tasks

Array of OpsAnalysisTaskListInfo objects

参数解释:

任务列表,表示当前分页下的任务详情列表。

取值范围:

符合OpsAnalysisTask 定义的对象数组。

表3 OpsAnalysisTaskStatusCount

参数

参数类型

描述

draft

Integer

参数解释:

草稿任务个数。

取值范围:

0-1000的整数。

scheduled

Integer

参数解释:

待运行的任务个数。

取值范围:

0-1000的整数。

running

Integer

参数解释:

运行中任务个数。

取值范围:

0-1000的整数。

paused

Integer

参数解释:

已暂停任务个数。

取值范围:

0-1000的整数。

completed

Integer

参数解释:

完成的任务个数。

取值范围:

0-1000的整数。

fail

Integer

参数解释:

失败任务个数。

取值范围:

0-1000的整数。

stopping

Integer

参数解释:

停止中任务个数。

取值范围:

0-1000的整数。

stopped

Integer

参数解释:

已停止任务个数。

取值范围:

0-1000的整数。

表4 OpsAnalysisTaskListInfo

参数

参数类型

描述

id

String

参数解释:

智能体优化任务ID。

取值范围:

UUID格式字符串。

name

String

参数解释:

任务名称,用于标识和区分不同的分析任务。

取值范围:

长度1-64个字符,支持中文、字母、数字、中划线及下划线。

description

String

参数解释:

任务的详细描述,用于记录任务目的或备注信息。

取值范围:

长度0-1024个字符。

agent

OpsAnalysisTaskAgent object

参数解释:

分析任务智能体。

取值范围:

不涉及。

agency_name

String

参数解释:

委托名称,赋予服务访问用户资源的权限。

取值范围:

合法的委托名称字符串。

status

String

参数解释:

任务状态。

取值范围:

draft:草稿态,scheduled:待运行,running:运行中,paused:已暂停,completed:已完成,fail:失败,stopping:停止中,stopped:已停止。

created_at

Long

参数解释:

创建时间,单位:毫秒(13位时间戳)。

取值范围:

13位毫秒级时间戳。

updated_at

Long

参数解释:

更新时间(单位:毫秒)

取值范围:

13位毫秒级时间戳。

next_fire_time

Long

参数解释:

计划下次执行时间。对于待运行、运行中的周期任务,显示下一个task instance时间。对于其他状态的周期任务为null。对待运行的单次任务显示计划运行时间。无后续调度时为 null。

取值范围:

13位毫秒级时间戳或 null。

tags

Array of OpsTasksTagForTMS objects

参数解释:

资源标签列表,用于资源分类。

取值范围:

数组长度0-20。

progress

OpsTaskProgress object

参数解释:

当前分析任务的进度

取值范围:

不涉及

execution_strategy

OpsExecutionStrategy object

参数解释: 执行策略配置。

取值范围: 不涉及。

status_count

OpsAnalysisTaskInstanceStatusCount object

参数解释: 各个状态下的分析任务task-instance总数。

取值范围: 不涉及

表5 OpsAnalysisTaskAgent

参数

参数类型

描述

type

String

参数解释:

智能体类型。

取值范围:

agent:单智能体,workflow:工作流,agentrun:部署在运行时的智能体,third_party:三方接入观测的智能体。

id

String

参数解释:

智能体ID,对应AgentArts平台中的智能体实例。

可在AgentArts平台“开发中心 > 智能体管理”页面获取ID,注意对应的智能体需要是“已提交”状态。

取值范围:

有效标识符字符串。

表6 OpsTasksTagForTMS

参数

参数类型

描述

key

String

参数解释:

标签键,标识资源的分类维度。

取值范围:

最大长度128个unicode字符。

value

String

参数解释:

标签值,具体的分类值。

取值范围:

不校验字符集范围。每个值最大长度255个unicode字符。

表7 OpsTaskProgress

参数

参数类型

描述

total

Integer

参数解释:

对于周期任务,表示总计计划执行的次数。

对于运行中的单次任务,值为计划要分析的trace条数。

对还未开始运行的单次任务,值为null。

取值范围: null或0-5000

progressed

Integer

参数解释:

对于周期任务,表示已经处理的次数。

对于运行中的单次任务,值为已经分析的trace条数。

对还未开始运行的单次任务,值为0。

取值范围: 0-5000

progress_rate

Integer

参数解释:

进度百分比

取值范围:

0-100

表8 OpsExecutionStrategy

参数

参数类型

描述

start_time

Long

参数解释:

开始时间(单位:毫秒数)

取值范围:

13位毫秒级时间戳。

end_time

Long

参数解释:

结束时间(单位:毫秒数)

取值范围:

13位毫秒级时间戳。

repeat

Boolean

参数解释:

是否重复执行。

取值范围:

true或者false。

repeat_type

String

参数解释:

重复周期类型。

取值范围:

daily:天重复,weekly:周重复。

repeat_interval

Integer

参数解释:

重复周期。

取值范围:

1到6之间的数字。

day_of_week

Integer

参数解释:

周重复时,每周几执行。

取值范围:

1到7之间的数字,分别代表周一到周日;daily 场景为 null。

表9 OpsAnalysisTaskInstanceStatusCount

参数

参数类型

描述

scheduled

Integer

参数解释: 待运行task_instance个数。 取值范围: 0-30的整数。

running

Integer

参数解释: 运行中task_instance个数。 取值范围: 0-30的整数。

skipped

Integer

参数解释: 跳过task_instance个数。 取值范围: 0-30的整数。

success

Integer

参数解释: 成功完成task_instance个数。 取值范围: 0-30的整数。

fail

Integer

参数解释: 运行失败task_instance个数。 取值范围: 0-30的整数。

stopped

Integer

参数解释: 已停止task_instance个数。 取值范围: 0-30的整数。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

机器可读的错误代码。

取值范围:

系统错误码字符串。

error_msg

String

参数解释:

人类可读的错误消息。

取值范围:

详细错误说明字符串。

状态码:403

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:机器可读的错误代码。

取值范围:系统错误码字符串。

error_msg

String

参数解释:人类可读的错误消息。

取值范围:详细错误说明字符串。

encoded_authorization_message

String

参数解释:编码后的授权失败信息。

取值范围:字符串。

details

Array of OpsRLCommonError objects

参数解释:依赖的下游服务错误信息列表。

取值范围:包含error_code和error_msg的对象数组。

表12 OpsRLCommonError

参数

参数类型

描述

error_code

String

参数解释:

机器可读的错误代码。

取值范围:

系统错误码字符串。

error_msg

String

参数解释:

人类可读的错误消息。

取值范围:

详细错误说明字符串。

状态码:429

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

机器可读的错误代码。

取值范围:

系统错误码字符串。

error_msg

String

参数解释:

人类可读的错误消息。

取值范围:

详细错误说明字符串。

状态码:500

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

机器可读的错误代码。

取值范围:

系统错误码字符串。

error_msg

String

参数解释:

人类可读的错误消息。

取值范围:

详细错误说明字符串。

请求示例

查询当前租户下的分析任务列表,支持通过任务名称和任务状态进行过滤,并支持分页功能。

GET /v1/ops/analysis-tasks?offset=0&limit=10&name=test&status=running

响应示例

状态码:200

参数解释:

任务列表数据。

取值范围:

无

{
  "total" : 1,
  "status_count" : {
    "draft" : 0,
    "scheduled" : 0,
    "running" : 1,
    "paused" : 0,
    "completed" : 0,
    "fail" : 0,
    "stopping" : 0,
    "stopped" : 0
  },
  "tasks" : [ {
    "id" : "57ae91cf2f504899921a50d1c75f0547",
    "name" : "test",
    "description" : "这是一个测试分析任务",
    "agent" : {
      "type" : "agent",
      "id" : "f0fab58d-8285-4c47-b856-1079cad579da"
    },
    "agency_name" : "ops-analysis-agency",
    "status" : "running",
    "created_at" : 1744214400000,
    "updated_at" : 1744218000000,
    "next_fire_time" : 1744300800000,
    "progress" : {
      "total" : 7,
      "progressed" : 2,
      "progress_rate" : 28
    },
    "execution_strategy" : {
      "start_time" : 1744214400000,
      "end_time" : 1744819200000,
      "repeat" : true,
      "repeat_type" : "daily",
      "repeat_interval" : 1
    },
    "tags" : [ {
      "key" : "project",
      "value" : "ops-demo"
    } ]
  } ]
}

状态码

状态码

描述

200

任务列表数据。

400

无效的请求参数。

403

权限不足。

429

请求频率超限。

500

内部服务器错误。

错误码

请参见错误码。

相关文档