查询分析任务实例列表 - ListOpsAnalysisTaskInstances
功能介绍
本接口用于查询指定分析任务下的任务实例列表,支持通过任务状态进行过滤,并支持分页功能。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:analysisTask:listOpsAnalysisTaskInstances | Read | analysisTask * | g:ResourceTag/<tag-key> | - | - |
URI
GET https://agentarts.region_id.myhuaweicloud.com/v1/ops/analysis-tasks/{analysis_task_id}/task-instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| analysis_task_id | 是 | String | 参数解释: 分析任务ID,标识任务的唯一标识符。获取方法请参考查询分析任务列表。 约束限制: 不涉及 取值范围: 32位ID字符串。 默认取值: 无 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 索引位置偏移量,用于指定从第几条记录开始返回,单位:条(记录数)。 约束限制: 不涉及 取值范围: 大于等于0的整数。 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 查询记录数,表示单页返回的最大任务数,单位:条。 约束限制: 不涉及 取值范围: 1到100的正整数。 默认取值: 无 |
| status | 否 | String | 参数解释: 任务状态,用于根据状态筛选任务。 约束限制: 不涉及 取值范围: scheduled: 待运行,running:运行中,skipped:跳过,success:成功完成,fail:运行失败,stopped:已停止。 默认取值: 无 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 满足过滤条件的记录总数,用于计算分页总页数。 取值范围: 0-100的整数。 |
| task_instances | Array of OpsAnalysisTaskInstanceListInfo objects | 参数解释: 具体分析任务执行的记录信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 分析任务具体执行instance的ID。 取值范围: UUID格式字符串。 |
| status | String | 参数解释: 分析任务具体执行instance的状态。 取值范围: scheduled: 待运行,running:运行中,skipped:跳过,success:成功完成,fail:运行失败,stopped:已停止。 |
| planned_start_time | Long | 参数解释: 分析任务具体执行instance的计划执行时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳。 |
| instance_start_time | Long | 参数解释: 分析任务具体执行instance的实际开始执行时间,单位:毫秒(13位时间戳)。instance 尚未被认领执行时为 null。 取值范围: 13位毫秒级时间戳或 null。 |
| instance_end_time | Long | 参数解释: 分析任务具体执行instance的实际完成时间,单位:毫秒(13位时间戳)。instance 尚未完成时为 null。 取值范围: 13位毫秒级时间戳或 null。 |
| data_start_time | Long | 参数解释: 分析任务具体执行instance所分析的链路数据的起始时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳。 |
| data_end_time | Long | 参数解释: 分析任务具体执行instance所分析的链路数据的截止时间,单位:毫秒(13位时间戳)。 取值范围: 13位毫秒级时间戳。 |
| reason | String | 参数解释: instance失败或跳过的原因。success 时为 null。 取值范围: 不涉及 |
状态码: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 | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 机器可读的错误代码。 取值范围: 系统错误码字符串。 |
| error_msg | String | 参数解释: 人类可读的错误消息。 取值范围: 详细错误说明字符串。 |
请求示例
查询指定分析任务下的任务实例列表,支持通过任务状态进行过滤,并支持分页功能。
GET /v1/ops/analysis-tasks/57ae91cf2f504899921a50d1c75f0547/task-instances?offset=0&limit=10&status=running
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 任务列表数据。 |
| 400 | 无效的请求参数。 |
| 403 | 权限不足。 |
| 404 | 分析任务未找到 |
| 429 | 请求频率超限。 |
| 500 | 内部服务器错误。 |
错误码
请参见错误码。