功能描述

修改周期任务的全局参数

请求参数

通用参数

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

接口参数

字段 类型 必选 描述
task_id string 周期任务ID
bk_biz_id string 模板所属业务ID
constants dict 任务全局参数,详细信息见下面说明
scope string bk_biz_id 检索的作用域。默认为 cmdb_biz,此时检索的是绑定的 CMDB 业务 ID 为 bk_biz_id 的项目;当值为 project 时则检索项目 ID 为 bk_biz_id 的项目

constants KEY

变量 KEY,${key} 格式

constants VALUE

变量值

请求参数示例

  1. {
  2. "bk_app_code": "esb_test",
  3. "bk_app_secret": "xxx",
  4. "bk_token": "xxx",
  5. "bk_biz_id": "2",
  6. "task_id": "8",
  7. "constants": {
  8. "${bk_timing}": "100"
  9. }
  10. }

返回结果示例

  1. {
  2. "data": {
  3. "${bk_timing}": {
  4. "source_tag": "sleep_timer.bk_timing",
  5. "source_info": {
  6. "node76393dcfedcf73dbc726f1c4786d": [
  7. "bk_timing"
  8. ]
  9. },
  10. "name": "定时时间",
  11. "custom_type": "",
  12. "index": 0,
  13. "value": "15",
  14. "show_type": "show",
  15. "source_type": "component_inputs",
  16. "key": "${bk_timing}",
  17. "validation": "",
  18. "desc": ""
  19. }
  20. },
  21. "result": true
  22. }

返回结果参数说明

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

data KEY

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

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