通用参数

接口参数

字段 类型 必选 描述
task_id string 是 周期任务ID
bk_biz_id string 是 模板所属业务ID
scope string 否 bk_biz_id 检索的作用域。默认为 cmdb_biz，此时检索的是绑定的 CMDB 业务 ID 为 bk_biz_id 的项目；当值为 project 时则检索项目 ID 为 bk_biz_id 的项目 
  2.     "message": "",
  3.     "data": {
  4.         "cron": "1,2,3-19/2 2 3 4 5 (m/h/d/dM/MY)",
  5.         "total_run_count": 0,
  6.         "name": "定时2",
  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": "2",
  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.                 "nodea5c396a3ef0f9f3cd7d4d7695f78": {
  30.                     "outgoing": "linef69b59d165fb8c0061b46588c515",
  31.                     "incoming": "linecf7b7f10c87187a88b72c5f91177",
  32.                     "name": "暂停",
  33.                     "error_ignorable": false,
  34.                     "component": {
  35.                         "code": "pause_node",
  36.                         "data": {}
  37.                     },
  38.                     "stage_name": "步骤1",
  39.                     "optional": false,
  40.                     "type": "ServiceActivity",
  41.                     "id": "nodea5c396a3ef0f9f3cd7d4d7695f78",
  42.                     "loop": {}
  43.                 },
  44.                 "node76393dcfedcf73dbc726f1c4786d": {
  45.                     "outgoing": "linecf7b7f10c87187a88b72c5f91177",
  46.                     "incoming": "linecd597f19606c1455d661f71a582d",
  47.                     "name": "定时",
  48.                     "error_ignorable": false,
  49.                     "component": {
  50.                         "code": "sleep_timer",
  51.                         "data": {
  52.                             "bk_timing": {
  53.                                 "hook": true,
  54.                                 "value": "${bk_timing}"
  55.                             }
  56.                         }
  57.                     "stage_name": "步骤1",
  58.                     "optional": false,
  59.                     "type": "ServiceActivity",
  60.                     "id": "node76393dcfedcf73dbc726f1c4786d",
  61.                     "loop": {}
  62.                 }
  63.             },
  65.                 "incoming": "linef69b59d165fb8c0061b46588c515",
  66.                 "outgoing": "",
  67.                 "type": "EmptyEndEvent",
  68.                 "id": "node375320830be9c46cd89f4069857d",
  69.                 "name": ""
  70.             },
  71.             "outputs": [],
  72.             "flows": {
  73.                 "linef69b59d165fb8c0061b46588c515": {
  74.                     "is_default": false,
  75.                     "source": "nodea5c396a3ef0f9f3cd7d4d7695f78",
  76.                     "id": "linef69b59d165fb8c0061b46588c515",
  77.                     "target": "node375320830be9c46cd89f4069857d"
  78.                 },
  79.                 "linecd597f19606c1455d661f71a582d": {
  80.                     "is_default": false,
  81.                     "source": "node4e87796ddd76b0d59337b08f385d",
  82.                     "id": "linecd597f19606c1455d661f71a582d",
  83.                     "target": "node76393dcfedcf73dbc726f1c4786d"
  84.                 },
  85.                 "linecf7b7f10c87187a88b72c5f91177": {
  86.                     "is_default": false,
  87.                     "source": "node76393dcfedcf73dbc726f1c4786d",
  88.                     "id": "linecf7b7f10c87187a88b72c5f91177",
  89.                     "target": "nodea5c396a3ef0f9f3cd7d4d7695f78"
  90.                 }
  91.             },
  92.             "gateways": {},
  93.             "line": [
  94.                 {
  95.                     "source": {
  96.                         "id": "nodea5c396a3ef0f9f3cd7d4d7695f78",
  97.                         "arrow": "Right"
  98.                     },
  99.                     "target": {
  100.                         "id": "node375320830be9c46cd89f4069857d",
  101.                         "arrow": "Left"
  102.                     },
  103.                     "id": "linef69b59d165fb8c0061b46588c515"
  104.                 },
  105.                 {
  106.                     "source": {
  107.                         "id": "node4e87796ddd76b0d59337b08f385d",
  108.                         "arrow": "Right"
  109.                     },
  110.                     "id": "linecd597f19606c1455d661f71a582d",
  111.                     "target": {
  112.                         "id": "node76393dcfedcf73dbc726f1c4786d",
  113.                         "arrow": "Left"
  114.                     }
  115.                 },
  116.                 {
  117.                     "source": {
  118.                         "id": "node76393dcfedcf73dbc726f1c4786d",
  119.                         "arrow": "Right"
  120.                     },
  121.                     "target": {
  122.                         "id": "nodea5c396a3ef0f9f3cd7d4d7695f78",
  123.                     },
  124.                     "id": "linecf7b7f10c87187a88b72c5f91177"
  125.                 }
  126.             ],
  128.                 "incoming": "",
  129.                 "outgoing": "linecd597f19606c1455d661f71a582d",
  130.                 "type": "EmptyStartEvent",
  131.                 "id": "node4e87796ddd76b0d59337b08f385d",
  132.                 "name": ""
  133.             },
  134.             "constants": {
  135.                 "${bk_timing}": {
  136.                     "source_tag": "sleep_timer.bk_timing",
  137.                     "source_info": {
  138.                         "node76393dcfedcf73dbc726f1c4786d": [
  139.                             "bk_timing"
  140.                         ]
  141.                     },
  142.                     "name": "定时时间",
  143.                     "index": 0,
  144.                     "custom_type": "",
  145.                     "value": "2",
  146.                     "show_type": "show",
  147.                     "source_type": "component_inputs",
  148.                     "key": "${bk_timing}",
  149.                     "validation": "",
  150.                     "desc": ""
  151.                 }
  152.             },
  153.             "location": [
  154.                 {
  155.                     "stage_name": "步骤1",
  156.                     "name": "暂停",
  157.                     "y": 133,
  158.                     "x": 631,
  159.                     "type": "tasknode",
  160.                     "id": "nodea5c396a3ef0f9f3cd7d4d7695f78"
  161.                 },
  162.                 {
  163.                     "y": 150,
  164.                     "x": 80,
  165.                     "type": "startpoint",
  166.                     "id": "node4e87796ddd76b0d59337b08f385d"
  167.                 },
  168.                 {
  169.                     "y": 149,
  170.                     "x": 1092,
  171.                     "type": "endpoint",
  172.                     "id": "node375320830be9c46cd89f4069857d"
  173.                 },
  174.                 {
  175.                     "stage_name": "步骤1",
  176.                     "name": "定时",
  177.                     "y": 133,
  178.                     "x": 300,
  179.                     "type": "tasknode",
  180.                     "id": "node76393dcfedcf73dbc726f1c4786d"
  181.                 }
  182.             ]
  183.         },
  184.         "last_run_at": "",
  185.         "enabled": true,
  186.         "id": 5,
  187.         "template_id": "2"
  188.     },
  189. }

data

名称 类型 说明
cron string 周期调度表达式
total_run_count int 周期任务运行次数
name string 周期任务名
creator string 创建者
last_run_at string 上次运行时间
enabled bool 是否激活
id int 周期任务 ID
template_id string 用于创建该任务的模板 ID
form dict 该周期任务的参数表单对象
pipeline_tree dict 该周期任务的实例树

data.pipeline_tree

data.form KEY, data.pipeline_tree.constants KEY

全局变量 KEY，${key} 格式

data.form VALUE, 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 时有效，变量的来源节点信息