通用参数

接口参数

字段 类型 必选 描述
bk_biz_id string 是 模板所属业务ID
template_id string 是 模板ID
template_source string 否 流程模板来源，business:默认值，业务流程，common：公共流程
name string 是 任务名称
flow_type string 否 任务流程类型，common: 常规流程，common_func：职能化流程
constants dict 否 任务全局参数，详细信息见下面说明
exclude_task_nodes_id list 否 跳过执行的节点ID列表
scope string 否 bk_biz_id 检索的作用域。默认为 cmdb_biz，此时检索的是绑定的 CMDB 业务 ID 为 bk_biz_id 的项目；当值为 project 时则检索项目 ID 为 bk_biz_id 的项目

constants KEY

constants VALUE

  2.     "result": true,
  3.     "data": {
  4.         "task_id": 10,
  5.         "task_url": "http://bk_sops_host/taskflow/execute/3/?instance_id=15364",
  6.         "pipeline_tree": {
  7.             "activities": {
  8.                 "node9b5ae13799d63e179f0ce3088b62": {
  9.                     "outgoing": "line27bc7b4ccbcf37ddb9d1f6572a04",
  10.                     "incoming": "line490caa49d2a03e64829693281032",
  11.                     "name": "timing",
  12.                     "error_ignorable": false,
  13.                     "component": {
  14.                         "code": "sleep_timer",
  15.                         "data": {
  16.                             "bk_timing": {
  17.                                 "hook": false,
  18.                                 "value": "2"
  19.                             }
  20.                         }
  21.                     },
  22.                     "stage_name": "步骤1",
  23.                     "retryable": true,
  24.                     "skippable": true,
  25.                     "type": "ServiceActivity",
  26.                     "optional": false,
  27.                     "id": "node9b5ae13799d63e179f0ce3088b62",
  28.                     "loop": null
  29.                 },
  30.                 "node880ded556c6c3c269be3cedc64b6": {
  31.                     "outgoing": "line490caa49d2a03e64829693281032",
  32.                     "incoming": "lineb83161d6e0593ad68d9ec73a961b",
  33.                     "name": "暂停",
  34.                     "error_ignorable": false,
  35.                     "component": {
  36.                         "code": "pause_node",
  37.                         "data": {}
  38.                     },
  39.                     "stage_name": "步骤1",
  40.                     "retryable": true,
  41.                     "skippable": true,
  42.                     "type": "ServiceActivity",
  43.                     "id": "node880ded556c6c3c269be3cedc64b6",
  44.                     "loop": null
  45.                 }
  46.             },
  47.             "end_event": {
  48.                 "type": "EmptyEndEvent",
  49.                 "outgoing": "",
  50.                 "incoming": "line27bc7b4ccbcf37ddb9d1f6572a04",
  52.                 "name": ""
  53.             },
  54.             "outputs": [],
  55.             "flows": {
  56.                 "line490caa49d2a03e64829693281032": {
  57.                     "is_default": false,
  58.                     "source": "node880ded556c6c3c269be3cedc64b6",
  59.                     "id": "line490caa49d2a03e64829693281032",
  60.                     "target": "node9b5ae13799d63e179f0ce3088b62"
  61.                 },
  62.                 "lineb83161d6e0593ad68d9ec73a961b": {
  63.                     "is_default": false,
  64.                     "source": "noded383bc1d7387391f889c6bab18b8",
  65.                     "id": "lineb83161d6e0593ad68d9ec73a961b",
  66.                     "target": "node880ded556c6c3c269be3cedc64b6"
  67.                 },
  68.                 "line27bc7b4ccbcf37ddb9d1f6572a04": {
  69.                     "is_default": false,
  70.                     "source": "node9b5ae13799d63e179f0ce3088b62",
  71.                     "id": "line27bc7b4ccbcf37ddb9d1f6572a04",
  72.                     "target": "node5c48f37aa9f0351e8b43ab6a2295"
  73.                 }
  74.             },
  75.             "gateways": {},
  76.             "line": [
  77.                 {
  78.                     "source": {
  79.                         "id": "node9b5ae13799d63e179f0ce3088b62",
  80.                         "arrow": "Right"
  81.                     },
  82.                     "target": {
  83.                         "id": "node5c48f37aa9f0351e8b43ab6a2295",
  84.                         "arrow": "Left"
  85.                     },
  86.                     "id": "line27bc7b4ccbcf37ddb9d1f6572a04"
  87.                 },
  88.                 {
  89.                     "source": {
  90.                         "id": "node880ded556c6c3c269be3cedc64b6",
  91.                         "arrow": "Right"
  92.                     },
  93.                     "target": {
  94.                         "id": "node9b5ae13799d63e179f0ce3088b62",
  95.                         "arrow": "Left"
  96.                     },
  97.                 },
  98.                 {
  99.                     "source": {
  100.                         "id": "noded383bc1d7387391f889c6bab18b8",
  102.                     },
  103.                     "id": "lineb83161d6e0593ad68d9ec73a961b",
  104.                     "target": {
  105.                         "id": "node880ded556c6c3c269be3cedc64b6",
  106.                         "arrow": "Left"
  107.                     }
  108.                 }
  109.             ],
  110.             "start_event": {
  111.                 "type": "EmptyStartEvent",
  112.                 "outgoing": "lineb83161d6e0593ad68d9ec73a961b",
  113.                 "incoming": "",
  114.                 "id": "noded383bc1d7387391f889c6bab18b8",
  115.                 "name": ""
  116.             },
  117.             "id": "node7ef6970d06ad3bc092594cb5ec5f",
  118.             "constants": {},
  119.             "location": [
  120.                 {
  121.                     "stage_name": "步骤1",
  122.                     "name": "暂停",
  123.                     "y": 135,
  124.                     "x": 300,
  125.                     "type": "tasknode",
  126.                     "id": "node880ded556c6c3c269be3cedc64b6"
  127.                 },
  128.                 {
  129.                     "y": 150,
  130.                     "x": 1000,
  131.                     "type": "endpoint",
  132.                     "id": "node5c48f37aa9f0351e8b43ab6a2295"
  133.                 },
  134.                 {
  135.                     "stage_name": "步骤1",
  136.                     "name": "timing",
  137.                     "y": 135,
  138.                     "x": 595,
  139.                     "type": "tasknode",
  140.                     "id": "node9b5ae13799d63e179f0ce3088b62"
  141.                 },
  142.                 {
  143.                     "y": 150,
  144.                     "x": 80,
  145.                     "type": "startpoint",
  146.                     "id": "noded383bc1d7387391f889c6bab18b8"
  147.                 }
  148.             ]
  149.         }
  150.     }

data

字段 类型 描述
task_id int 任务实例ID
task_url str 任务实例链接
pipeline_tree dict 任务实例树

data.pipeline_tree

data.pipeline_tree.constants KEY

data.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 时有效，变量的来源标准插件
source_info dict source_type=component_inputs/component_outputs 时有效，变量的来源节点信息