功能描述

创建周期任务

请求参数

通用参数

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

接口参数

字段 类型 必选 描述
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

变量 KEY，${key} 格式

constants VALUE

变量值

cron

参数名称 参数类型 必须 参数说明
minute string 否 分，默认为 *
hour string 否 时，默认为 *
day_of_week string 否 一周内的某些天，默认为 *
day_of_month string 否 一个月中的某些天，默认为 *
month_of_year string 否 一年中的某些月份，默认为 *

请求参数示例

  1. {
  2.     "bk_app_code": "esb_test",
  3.     "bk_app_secret": "xxx",
  4.     "bk_token": "xxx",
  5.     "template_id": "1",
  6.     "bk_biz_id": "2",
  7.     "name": "from api 3",
  8.     "cron" : {
  9.         "minute": "*/1", 
  10.         "hour": "15", 
  11.         "day_of_week":"*", 
  12.         "day_of_month":"*", 
  13.         "month_of_year":"*"
  14.     },
  15.     "constants": {
  16.         "${bk_timing}": "100"
  17.     },
  18.     "exclude_task_nodes_id": ["nodea5c396a3ef0f9f3cd7d4d7695f78"]
  19. }

返回结果示例

  1. {
  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.                     },
  43.                     "stage_name": "步骤1",
  44.                     "optional": false,
  45.                     "type": "ServiceActivity",
  46.                     "id": "node76393dcfedcf73dbc726f1c4786d",
  47.                     "loop": {}
  48.                 }
  49.             },
  50.             "end_event": {
  51.                 "incoming": "linecf7b7f10c87187a88b72c5f91177",
  52.                 "outgoing": "",
  53.                 "type": "EmptyEndEvent",
  54.                 "id": "node375320830be9c46cd89f4069857d",
  55.                 "name": ""
  56.             },
  57.             "outputs": [],
  58.             "flows": {
  59.                 "linecd597f19606c1455d661f71a582d": {
  60.                     "is_default": false,
  61.                     "source": "node4e87796ddd76b0d59337b08f385d",
  62.                     "id": "linecd597f19606c1455d661f71a582d",
  63.                     "target": "node76393dcfedcf73dbc726f1c4786d"
  64.                 },
  65.                 "linecf7b7f10c87187a88b72c5f91177": {
  66.                     "is_default": false,
  67.                     "source": "node76393dcfedcf73dbc726f1c4786d",
  68.                     "id": "linecf7b7f10c87187a88b72c5f91177",
  69.                     "target": "node375320830be9c46cd89f4069857d"
  70.                 }
  71.             },
  72.             "gateways": {},
  73.             "line": [
  74.                 {
  75.                     "source": {
  76.                         "id": "node4e87796ddd76b0d59337b08f385d",
  77.                         "arrow": "Right"
  78.                     },
  79.                     "id": "linecd597f19606c1455d661f71a582d",
  80.                     "target": {
  81.                         "id": "node76393dcfedcf73dbc726f1c4786d",
  82.                         "arrow": "Left"
  83.                     }
  84.                 },
  85.                 {
  86.                     "source": {
  87.                         "id": "node76393dcfedcf73dbc726f1c4786d",
  88.                         "arrow": "Right"
  89.                     },
  90.                     "target": {
  91.                         "id": "node375320830be9c46cd89f4069857d",
  92.                         "arrow": "Left"
  93.                     },
  94.                     "id": "linecf7b7f10c87187a88b72c5f91177"
  95.                 }
  96.             ],
  97.             "start_event": {
  98.                 "incoming": "",
  99.                 "outgoing": "linecd597f19606c1455d661f71a582d",
  100.                 "type": "EmptyStartEvent",
  101.                 "id": "node4e87796ddd76b0d59337b08f385d",
  102.                 "name": ""
  103.             },
  104.             "constants": {
  105.                 "${bk_timing}": {
  106.                     "source_tag": "sleep_timer.bk_timing",
  107.                     "source_info": {
  108.                         "node76393dcfedcf73dbc726f1c4786d": [
  109.                             "bk_timing"
  110.                         ]
  111.                     },
  112.                     "name": "定时时间",
  113.                     "index": 0,
  114.                     "custom_type": "",
  115.                     "value": "100",
  116.                     "show_type": "show",
  117.                     "source_type": "component_inputs",
  118.                     "key": "${bk_timing}",
  119.                     "validation": "",
  120.                     "desc": ""
  121.                 }
  122.             },
  123.             "location": [
  124.                 {
  125.                     "y": 150,
  126.                     "x": 80,
  127.                     "type": "startpoint",
  128.                     "id": "node4e87796ddd76b0d59337b08f385d"
  129.                 },
  130.                 {
  131.                     "y": 149,
  132.                     "x": 1092,
  133.                     "type": "endpoint",
  134.                     "id": "node375320830be9c46cd89f4069857d"
  135.                 },
  136.                 {
  137.                     "stage_name": "步骤1",
  138.                     "name": "定时",
  139.                     "y": 133,
  140.                     "x": 300,
  141.                     "type": "tasknode",
  142.                     "id": "node76393dcfedcf73dbc726f1c4786d"
  143.                 }
  144.             ]
  145.         },
  146.         "last_run_at": "",
  147.         "enabled": false,
  148.         "id": 11,
  149.         "template_id": 2
  150.     },
  151.     "result": true
  152. }

返回结果参数说明

名称 类型 说明
result bool true/false 操作是否成功
data dict result=true 时成功数据，详细信息请见下面说明
message string result=false 时错误信息

data

名称 类型 说明
cron string 周期调度表达式
total_run_count int 周期任务运行次数
name string 周期任务名
creator string 创建者
last_run_at string 上次运行时间
enabled bool 是否激活
id int 周期任务 ID
template_id string 用于创建该任务的模板 ID
template_source string 流程模板来源，business:默认值，业务流程，common：公共流程
form dict 该周期任务的参数表单对象
pipeline_tree dict 该周期任务的实例树

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

全局变量 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 时有效，变量的来源节点信息