功能描述

查询任务或任务节点执行状态

请求参数

通用参数

字段 类型 必选 描述
bk_app_code string 应用ID
bk_app_secret string 安全密钥(应用 TOKEN),可以通过 蓝鲸智云开发者中心 -> 点击应用ID -> 基本信息 获取
bk_token string 当前用户登录态,bk_token与bk_username必须一个有效,bk_token可以通过Cookie获取
bk_username string 当前用户用户名,应用免登录态验证白名单中的应用,用此字段指定当前用户

接口参数

字段 类型 必选 描述
bk_biz_id string 模板所属业务ID
task_id string 任务或节点ID
scope string bk_biz_id 检索的作用域。默认为 cmdb_biz,此时检索的是绑定的 CMDB 业务 ID 为 bk_biz_id 的项目;当值为 project 时则检索项目 ID 为 bk_biz_id 的项目

请求参数示例

  1. {
  2. "bk_app_code": "esb_test",
  3. "bk_app_secret": "xxx",
  4. "bk_token": "xxx",
  5. "bk_biz_id": "2",
  6. "task_id": "10"
  7. }

返回结果示例

  1. {
  2. "result": true,
  3. "data": {
  4. "retry": 0,
  5. "name": "<class 'pipeline.core.pipeline.Pipeline'>",
  6. "finish_time": "",
  7. "skip": false,
  8. "start_time": "2018-04-26 16:08:34 +0800",
  9. "children": {
  10. "62d4784e20483f1585149ce90ed954c9": {
  11. "retry": 0,
  12. "name": "<class 'pipeline.core.flow.event.EmptyStartEvent'>",
  13. "finish_time": "2018-04-26 16:08:34 +0800",
  14. "skip": false,
  15. "start_time": "2018-04-26 16:08:34 +0800",
  16. "children": {},
  17. "state": "FINISHED",
  18. "version": "7447cc2801b630f497768493c02fb488",
  19. "id": "62d4784e20483f1585149ce90ed954c9",
  20. "loop": 1
  21. },
  22. "e8b128dff46637368b9b1bd921abc14e": {
  23. "retry": 0,
  24. "name": "<class 'pipeline.core.flow.activity.ServiceActivity'>",
  25. "finish_time": "2018-04-26 16:08:46 +0800",
  26. "skip": false,
  27. "start_time": "2018-04-26 16:08:34 +0800",
  28. "children": {},
  29. "state": "FAILED",
  30. "version": "914d35fe7d143c2186e6d3532870b37d",
  31. "id": "e8b128dff46637368b9b1bd921abc14e",
  32. "loop": 1
  33. }
  34. },
  35. "state": "FAILED",
  36. "version": "",
  37. "id": "5a1622f9f43e3429acb604e18dbd100a",
  38. "loop": 1
  39. }
  40. }

返回结果参数说明

字段 类型 描述
result bool true/false 查询成功与否
data dict result=true 时返回数据,详细信息见下面说明
message string result=false 时错误信息

data

字段 类型 描述
state string 任务或节点状态,详细信息见下面说明
id string 任务或节点执行态ID,不等于 task_id
skip bool 是否跳过执行
retry int 重试和跳过总次数
start_time string 任务或节点执行开始时间
finish_time string 任务或节点执行结束时间
children dict 任务节点执行详情,详细信息见下面说明
name string 节点名称

data.state

返回值 描述
CREATED 未执行
RUNNING 执行中
FAILED 失败
SUSPENDED 暂停
REVOKED 已终止
FINISHED 已完成

data.children KEY

任务节点执行态ID

data.children VALUE

同 data 格式