通用参数

接口参数

字段 类型 必选 描述
template_id string 是 用于创建任务的模板ID
template_source string 否 流程模板来源，business:默认值，业务流程，common：公共流程
bk_biz_id string 是 任务所属业务ID
name string 是 要创建的周期任务名称
cron dict 是 要创建的周期任务调度策略
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

cron

  2.     "message": "",
  3.     "data": {
  4.         "cron": "*/1 15 * * * (m/h/d/dM/MY)",
  5.         "total_run_count": 0,
  6.         "name": "from api 3",
  7.         "form": {
  8.             "${bk_timing}": {
  9.                 "source_tag": "sleep_timer.bk_timing",
  10.                 "source_info": {
  11.                     "node76393dcfedcf73dbc726f1c4786d": [
  12.                         "bk_timing"
  13.                     ]
  14.                 },
  15.                 "name": "定时时间",
  16.                 "index": 0,
  17.                 "custom_type": "",
  18.                 "value": "100",
  19.                 "show_type": "show",
  20.                 "source_type": "component_inputs",
  21.                 "key": "${bk_timing}",
  22.                 "validation": "",
  23.                 "desc": ""
  24.             }
  25.         },
  26.         "creator": "admin",
  27.         "pipeline_tree": {
  28.             "activities": {
  29.                 "node76393dcfedcf73dbc726f1c4786d": {
  30.                     "outgoing": "linecf7b7f10c87187a88b72c5f91177",
  31.                     "incoming": "linecd597f19606c1455d661f71a582d",
  32.                     "name": "定时",
  33.                     "error_ignorable": false,
  34.                     "component": {
  35.                         "code": "sleep_timer",
  36.                         "data": {
  37.                             "bk_timing": {
  38.                                 "hook": true,
  39.                                 "value": "${bk_timing}"
  40.                             }
  41.                         }
  42.                     "stage_name": "步骤1",
  43.                     "optional": false,
  44.                     "type": "ServiceActivity",
  45.                     "id": "node76393dcfedcf73dbc726f1c4786d",
  46.                     "loop": {}
  47.                 }
  48.             },
  49.             "end_event": {
  51.                 "outgoing": "",
  52.                 "type": "EmptyEndEvent",
  53.                 "id": "node375320830be9c46cd89f4069857d",
  54.                 "name": ""
  55.             },
  56.             "outputs": [],
  57.             "flows": {
  58.                 "linecd597f19606c1455d661f71a582d": {
  59.                     "is_default": false,
  60.                     "source": "node4e87796ddd76b0d59337b08f385d",
  61.                     "id": "linecd597f19606c1455d661f71a582d",
  62.                     "target": "node76393dcfedcf73dbc726f1c4786d"
  63.                 },
  64.                 "linecf7b7f10c87187a88b72c5f91177": {
  65.                     "is_default": false,
  66.                     "source": "node76393dcfedcf73dbc726f1c4786d",
  67.                     "id": "linecf7b7f10c87187a88b72c5f91177",
  68.                     "target": "node375320830be9c46cd89f4069857d"
  69.                 }
  70.             },
  71.             "gateways": {},
  72.             "line": [
  73.                 {
  74.                     "source": {
  75.                         "id": "node4e87796ddd76b0d59337b08f385d",
  76.                         "arrow": "Right"
  77.                     },
  78.                     "id": "linecd597f19606c1455d661f71a582d",
  79.                     "target": {
  80.                         "id": "node76393dcfedcf73dbc726f1c4786d",
  81.                         "arrow": "Left"
  82.                     }
  83.                 },
  84.                 {
  85.                     "source": {
  86.                         "id": "node76393dcfedcf73dbc726f1c4786d",
  87.                         "arrow": "Right"
  88.                     },
  89.                     "target": {
  90.                         "id": "node375320830be9c46cd89f4069857d",
  91.                         "arrow": "Left"
  92.                     },
  93.                     "id": "linecf7b7f10c87187a88b72c5f91177"
  94.                 }
  95.             ],
  96.                 "incoming": "",
  97.                 "outgoing": "linecd597f19606c1455d661f71a582d",
  98.                 "type": "EmptyStartEvent",
  100.                 "name": ""
  101.             },
  102.             "constants": {
  103.                 "${bk_timing}": {
  104.                     "source_tag": "sleep_timer.bk_timing",
  105.                     "source_info": {
  106.                         "node76393dcfedcf73dbc726f1c4786d": [
  107.                             "bk_timing"
  108.                         ]
  109.                     },
  110.                     "name": "定时时间",
  111.                     "index": 0,
  112.                     "custom_type": "",
  113.                     "value": "100",
  114.                     "show_type": "show",
  115.                     "source_type": "component_inputs",
  116.                     "key": "${bk_timing}",
  117.                     "validation": "",
  118.                     "desc": ""
  119.                 }
  120.             },
  121.             "location": [
  122.                 {
  123.                     "y": 150,
  124.                     "x": 80,
  125.                     "type": "startpoint",
  126.                     "id": "node4e87796ddd76b0d59337b08f385d"
  127.                 },
  128.                 {
  129.                     "y": 149,
  130.                     "x": 1092,
  131.                     "type": "endpoint",
  132.                     "id": "node375320830be9c46cd89f4069857d"
  133.                 },
  134.                 {
  135.                     "stage_name": "步骤1",
  136.                     "name": "定时",
  137.                     "y": 133,
  138.                     "x": 300,
  139.                     "type": "tasknode",
  140.                     "id": "node76393dcfedcf73dbc726f1c4786d"
  141.                 }
  142.             ]
  143.         },
  144.         "last_run_at": "",
  145.         "enabled": false,
  146.         "id": 11,
  147.         "template_id": 2
  148.     },
名称 类型 说明
result bool true/false 操作是否成功
data dict result=true 时成功数据，详细信息请见下面说明
message string result=false 时错误信息

data

data.pipeline_tree

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

data.form KEY, data.pipeline_tree.constants KEY

data.form VALUE, data.pipeline_tree.constants VALUE