通用参数

接口参数

字段 类型 必选 描述
project_id int 是 项目ID
name string 是 任务名称
pipeline_tree dict 是 任务实例树，详细信息请见下面说明
flow_type string 否 任务流程类型，common: 常规流程，common_func：职能化流程，默认值为common
description string 否 任务描述
category string 否 任务分类，详细信息请见下面说明
scope string 否 project_id 检索的作用域。默认为 cmdb_biz，此时检索的是绑定的 CMDB 业务 ID 为 bk_biz_id 的项目；当值为 project 时则检索项目 ID 为 project_id 的项目

category

值 描述
OpsTools 运维工具
MonitorAlarm 监控告警
ConfManage 配置管理
DevTools 开发工具
EnterpriseIT 企业IT
OfficeApp 办公应用
Other 其它

pipeline_tree

字段 类型 必选 描述
start_event dict 是 开始节点，详细信息请见下面说明
end_event dict 是 结束节点，详细信息请见下面说明
activities dict 是 任务节点（标准插件和子流程），详细信息请见下面说明
flows dict 是 顺序流（节点连线），详细信息请见下面说明
gateways dict 否 网关节点（并行网关、分支网关和汇聚网关），详细信息请见下面说明
constants dict 否 全局变量，详细信息请见下面说明
outputs list 否 输出参数，标记 constants 中的输出字段

pipeline_tree.start_event

pipeline_tree.end_event

字段 类型 必选 描述
id string 是 结束节点 ID，在 pipeline_tree 所有ID中全局唯一
type string 是 结束节点类型，当前只支持 EmptyEndEvent：空结束类
name string 是 结束节点名称，可为空
incoming string 是 入度顺序流 ID
outgoing string 是 出度顺序流 ID，必须为空字符串

pipeline_tree.activities KEY、pipeline_tree.flows KEY、pipeline_tree.gateways KEY

pipeline_tree.activities VALUE

字段 类型 必选 描述
id string 是 任务节点 ID，同 KEY 一致
type string 是 任务节点类型，当前只支持 ServiceActivity：标准插件节点
name string 是 任务节点名称
component dict 是 插件配置，详细信息请见下面说明
error_ignorable bool 是 节点失败是否自动忽略
retryable bool 是 节点失败后是否可以重试，error_ignorable 为 true 时该参数无效
skippable bool 是 节点失败后是否可以跳过，error_ignorable 为 true 时该参数无效
incoming string 是 入度顺序流 ID
outgoing string 是 出度顺序流 ID
stage_name string 否 步骤分组名称

pipeline_tree.activities VALUE.component

字段 类型 必选 描述
code string 是 标准插件编码
data dict 是 标准插件输入参数

pipeline_tree.flows VALUE

pipeline_tree.gateways VALUE

字段 类型 必选 描述
id string 是 网关节点 ID，同 KEY 一致
type string 是 网关类型，ParallelGateway：并行网关，ExclusiveGateway：分支网关，ConvergeGateway：汇聚网关
name string 是 网关节点名称，可为空
incoming string/list 是 入度顺序流 ID，type 为 ConvergeGateway 时是 list，否则是 string
outgoing string/list 是 出度顺序流 ID，type 为 ConvergeGateway 时是 string，否则是 list
conditions dict 否 分支条件，type 为 ExclusiveGateway 必填， 详细信息请见下面说明

pipeline_tree.gateways VALUE.conditions KEY

pipeline_tree.gateways VALUE.conditions VALUE

字段 类型 必选 描述
evaluate string 是 分支表达式，支持的语法请参考产品白皮书等文档

pipeline_tree.constants KEY

pipeline_tree.constants VALUE

字段 类型 必选 描述
key string 是 同 KEY 一致
name string 是 变量名字
index int 是 变量在任务中的显示顺序
desc string 是 变量说明
source_type string 是 变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选
custom_type string 是 source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数
source_tag string 是 source_type=component_inputs 或 component_outputs 时有效，变量的来源插件和 Tag
source_info dict 是 source_type=component_inputs 或 component_outputs 时有效，变量的来源节点信息 
  2.     "result": true,
  3.     "data": {
  4.         "task_id": 10,
  5.         "task_url": "http://bk_sops_host/taskflow/execute/3/?instance_id=10",
  6.         "pipeline_tree": {
  7.             "start_event": {
  8.                 "incoming": "",
  9.                 "outgoing": "line7ed74aa679d19063b6d7037ce6db",
  10.                 "type": "EmptyStartEvent",
  11.                 "id": "node20cbeaa5379d08e8d8ed7bb44fdc",
  12.                 "name": ""
  13.             },
  14.             "activities": {
  15.                 "node5310ec36c0364d3094d515f8f5ef": {
  16.                     "outgoing": "linec02d1e77e1076aa9c7c2c57238e4",
  17.                     "incoming": "line7ed74aa679d19063b6d7037ce6db",
  18.                     "name": "node1",
  19.                     "error_ignorable": false,
  20.                     "component": {
  21.                         "code": "sleep_timer",
  22.                         "data": {
  23.                             "bk_timing": {
  24.                                 "hook": true,
  25.                                 "value": "${bk_timing}"
  26.                             }
  27.                         }
  28.                     },
  29.                     "stage_name": "stage1",
  30.                     "retryable": true,
  31.                     "skippable": true,
  32.                     "type": "ServiceActivity",
  33.                     "id": "node5310ec36c0364d3094d515f8f5ef"
  34.                 },
  35.                 "node2bf42efcebe266706c3e21326dc4": {
  36.                     "outgoing": "linef0deadac69f769440a1b0e32587e",
  37.                     "incoming": "line7587c8804d34a091dae3d321f081",
  38.                     "name": "node2",
  39.                     "error_ignorable": false,
  40.                     "component": {
  41.                         "code": "sleep_timer",
  42.                         "data": {
  43.                             "bk_timing": {
  44.                                 "hook": true,
  45.                                 "value": "${bk_timing}"
  46.                             }
  47.                         }
  48.                     },
  49.                     "stage_name": "stage2",
  50.                     "retryable": true,
  51.                     "skippable": true,
  52.                     "type": "ServiceActivity",
  53.                     "id": "node2bf42efcebe266706c3e21326dc4"
  54.                 },
  55.                 "node3c7dcf31454c1e9bdc9cf1cdeacc": {
  56.                     "outgoing": "linebf8f91c96a8f4eb3794ca5eb9881",
  57.                     "incoming": "line429f64cdec5d20f368611e621ef5",
  58.                     "name": "node3",
  59.                     "error_ignorable": false,
  60.                     "component": {
  61.                         "code": "sleep_timer",
  62.                         "data": {
  63.                                 "hook": false,
  64.                                 "value": "3"
  65.                             }
  66.                         }
  67.                     },
  68.                     "stage_name": "stage3",
  69.                     "retryable": true,
  70.                     "skippable": true,
  71.                     "type": "ServiceActivity",
  72.                     "id": "node3c7dcf31454c1e9bdc9cf1cdeacc"
  73.                 },
  74.                 "nodedb1478a75c13f90cc400f5379949": {
  75.                     "outgoing": "line24d28a3f9f80e23e4a4fab7c4ffd",
  77.                     "name": "node4",
  78.                     "error_ignorable": false,
  79.                     "component": {
  80.                         "code": "sleep_timer",
  81.                         "data": {
  82.                             "bk_timing": {
  83.                                 "hook": true,
  84.                                 "value": "${bk_timing}"
  85.                             }
  86.                         }
  87.                     },
  88.                     "stage_name": "stage3",
  89.                     "retryable": true,
  90.                     "skippable": true,
  91.                     "type": "ServiceActivity",
  92.                     "id": "nodedb1478a75c13f90cc400f5379949"
  93.                 }
  94.             },
  95.             "end_event": {
  96.                 "incoming": "line6ea858554964a04d868cead4435a",
  97.                 "outgoing": "",
  98.                 "type": "EmptyEndEvent",
  99.                 "id": "nodebe0db4ad30cc1723c7ede37b4b5f",
  100.                 "name": ""
  101.             },
  102.             "flows": {
  103.                 "line24d28a3f9f80e23e4a4fab7c4ffd": {
  104.                     "is_default": false,
  105.                     "source": "nodedb1478a75c13f90cc400f5379949",
  106.                     "id": "line24d28a3f9f80e23e4a4fab7c4ffd",
  107.                     "target": "node947e423b22e49aeb77bc77528bc0"
  108.                 },
  109.                 "linebf8f91c96a8f4eb3794ca5eb9881": {
  110.                     "is_default": false,
  111.                     "source": "node3c7dcf31454c1e9bdc9cf1cdeacc",
  112.                     "id": "linebf8f91c96a8f4eb3794ca5eb9881",
  113.                     "target": "node947e423b22e49aeb77bc77528bc0"
  114.                 },
  115.                 "line7587c8804d34a091dae3d321f081": {
  116.                     "is_default": false,
  117.                     "source": "node0863aab8325b84cfa3e5db52dc61",
  118.                     "id": "line7587c8804d34a091dae3d321f081",
  119.                     "target": "node2bf42efcebe266706c3e21326dc4"
  120.                 },
  121.                 "line429f64cdec5d20f368611e621ef5": {
  122.                     "is_default": false,
  123.                     "source": "node7e97af0f55fb64276e067951dd9d",
  124.                     "id": "line429f64cdec5d20f368611e621ef5",
  125.                     "target": "node3c7dcf31454c1e9bdc9cf1cdeacc"
  126.                 },
  127.                 "line6ea858554964a04d868cead4435a": {
  128.                     "is_default": false,
  129.                     "source": "node2b6f3285cfb3961c72834bafbe1b",
  130.                     "id": "line6ea858554964a04d868cead4435a",
  131.                     "target": "nodebe0db4ad30cc1723c7ede37b4b5f"
  132.                 },
  133.                 "line9dd9c8dbbad90943f268442ab7e0": {
  134.                     "is_default": false,
  135.                     "source": "node0863aab8325b84cfa3e5db52dc61",
  136.                     "id": "line9dd9c8dbbad90943f268442ab7e0",
  137.                     "target": "node7e97af0f55fb64276e067951dd9d"
  138.                 },
  139.                 "lineabc279d9be88eb98285132ba5b75": {
  140.                     "is_default": false,
  141.                     "source": "node947e423b22e49aeb77bc77528bc0",
  142.                     "id": "lineabc279d9be88eb98285132ba5b75",
  143.                     "target": "node2b6f3285cfb3961c72834bafbe1b"
  144.                 },
  145.                 "linef0deadac69f769440a1b0e32587e": {
  146.                     "source": "node2bf42efcebe266706c3e21326dc4",
  147.                     "id": "linef0deadac69f769440a1b0e32587e",
  148.                     "target": "node2b6f3285cfb3961c72834bafbe1b"
  149.                 },
  150.                 "linec02d1e77e1076aa9c7c2c57238e4": {
  152.                     "source": "node5310ec36c0364d3094d515f8f5ef",
  153.                     "id": "linec02d1e77e1076aa9c7c2c57238e4",
  154.                     "target": "node0863aab8325b84cfa3e5db52dc61"
  155.                 },
  156.                 "line7ed74aa679d19063b6d7037ce6db": {
  157.                     "is_default": false,
  158.                     "source": "node20cbeaa5379d08e8d8ed7bb44fdc",
  159.                     "id": "line7ed74aa679d19063b6d7037ce6db",
  160.                     "target": "node5310ec36c0364d3094d515f8f5ef"
  161.                 },
  162.                 "linec43c77f26af408748a9c194dbcfe": {
  163.                     "is_default": false,
  164.                     "source": "node7e97af0f55fb64276e067951dd9d",
  165.                     "id": "linec43c77f26af408748a9c194dbcfe",
  166.                     "target": "nodedb1478a75c13f90cc400f5379949"
  167.                 }
  168.             },
  169.             "gateways": {
  170.                 "node2b6f3285cfb3961c72834bafbe1b": {
  171.                     "incoming": ["linef0deadac69f769440a1b0e32587e", "lineabc279d9be88eb98285132ba5b75"],
  172.                     "outgoing": "line6ea858554964a04d868cead4435a",
  173.                     "type": "ConvergeGateway",
  174.                     "id": "node2b6f3285cfb3961c72834bafbe1b",
  175.                     "name": ""
  176.                 },
  177.                 "node0863aab8325b84cfa3e5db52dc61": {
  178.                     "outgoing": ["line7587c8804d34a091dae3d321f081", "line9dd9c8dbbad90943f268442ab7e0"],
  179.                     "incoming": "linec02d1e77e1076aa9c7c2c57238e4",
  180.                     "name": "",
  181.                     "type": "ExclusiveGateway",
  182.                     "conditions": {
  183.                         "line9dd9c8dbbad90943f268442ab7e0": {
  184.                             "evaluate": "${bk_timing} <= 10"
  185.                         },
  186.                         "line7587c8804d34a091dae3d321f081": {
  187.                             "evaluate": "${bk_timing} > 10"
  188.                         }
  189.                     },
  190.                     "id": "node0863aab8325b84cfa3e5db52dc61"
  191.                 },
  192.                 "node947e423b22e49aeb77bc77528bc0": {
  193.                     "incoming": ["linebf8f91c96a8f4eb3794ca5eb9881", "line24d28a3f9f80e23e4a4fab7c4ffd"],
  194.                     "outgoing": "lineabc279d9be88eb98285132ba5b75",
  195.                     "type": "ConvergeGateway",
  196.                     "id": "node947e423b22e49aeb77bc77528bc0",
  197.                     "name": ""
  198.                 },
  199.                 "node7e97af0f55fb64276e067951dd9d": {
  200.                     "incoming": "line9dd9c8dbbad90943f268442ab7e0",
  201.                     "outgoing": ["line429f64cdec5d20f368611e621ef5", "linec43c77f26af408748a9c194dbcfe"],
  202.                     "type": "ParallelGateway",
  203.                     "id": "node7e97af0f55fb64276e067951dd9d",
  204.                     "name": ""
  205.                 }
  206.             },
  207.             "constants": {
  208.                 "${bk_timing}": {
  209.                     "source_tag": "sleep_timer.bk_timing",
  210.                     "source_info": {
  211.                         "node5310ec36c0364d3094d515f8f5ef": ["bk_timing"],
  212.                         "node2bf42efcebe266706c3e21326dc4": ["bk_timing"],
  213.                         "nodedb1478a75c13f90cc400f5379949": ["bk_timing"]
  214.                     },
  215.                     "name": "timing",
  216.                     "index": 0,
  217.                     "custom_type": "",
  218.                     "value": "1",
  219.                     "show_type": "show",
  220.                     "source_type": "component_inputs",
  221.                     "key": "${bk_timing}",
  222.                     "desc": ""
  223.                 }
  224.             },
  225.             "outputs": ["${bk_timing}"]
  226.         }
  228. }

data

字段 类型 说明
task_id int 任务实例ID
task_url string 任务实例链接
pipeline_tree dict 任务实例树

data.pipeline_tree