功能描述

查询公共流程模板详情

请求参数

通用参数

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

请求参数示例

  1. {
  2.     "bk_app_code": "esb_test",
  3.     "bk_app_secret": "xxx",
  4.     "bk_token": "xxx",
  5.     "template_id": "30",
  6. }

返回结果示例

  1. {
  2.     "result": true,
  3.     "data": {
  4.         "category": "Other",
  5.         "edit_time": "2018-04-27 16:24:24 +0800",
  6.         "create_time": "2018-04-16 21:43:15 +0800",
  7.         "name": "new20180416213944",
  8.         "creator": "admin",
  9.         "pipeline_tree": {
  10.             "activities": {
  11.                 "631b6576cc5dfbdcaa4f510ce88a7e67": {
  12.                     "outgoing": "44ab36ebf4cf119edaf2d20401da87e4",
  13.                     "incoming": "fb2f3a8b533ca5c67e2440b4164f7632",
  14.                     "name": "节点_1",
  15.                     "error_ignorable": false,
  16.                     "component": {
  17.                         "code": "job_fast_execute_script",
  18.                         "data": {
  19.                             "account": {
  20.                                 "hook": false,
  21.                                 "value": "root"
  22.                             },
  23.                             "ip_list": {
  24.                                 "hook": false,
  25.                                 "value": "127.0.0.1"
  26.                             },
  27.                             "script_timeout": {
  28.                                 "hook": true,
  29.                                 "value": "${script_timeout}"
  30.                             },
  31.                             "content": {
  32.                                 "hook": false,
  33.                                 "value": "${content}"
  34.                             },
  35.                             "script_param": {
  36.                                 "hook": false,
  37.                                 "value": "${params}"
  38.                             },
  39.                             "script_type": {
  40.                                 "hook": true,
  41.                                 "value": "${script_type}"
  42.                             }
  43.                         }
  44.                     },
  45.                     "optional": false,
  46.                     "type": "ServiceActivity",
  47.                     "id": "631b6576cc5dfbdcaa4f510ce88a7e67",
  48.                     "loop": null
  49.                 }
  50.             },
  51.             "end_event": {
  52.                 "type": "EmptyEndEvent",
  53.                 "outgoing": "",
  54.                 "incoming": "44ab36ebf4cf119edaf2d20401da87e4",
  55.                 "id": "60c81e383d048d8a3c574d3436e1b82c",
  56.                 "name": ""
  57.             },
  58.             "outputs": [],
  59.             "flows": {
  60.                 "fb2f3a8b533ca5c67e2440b4164f7632": {
  61.                     "is_default": false,
  62.                     "source": "48afea1016ab70ee37179fa0eb1e1a14",
  63.                     "id": "fb2f3a8b533ca5c67e2440b4164f7632",
  64.                     "target": "631b6576cc5dfbdcaa4f510ce88a7e67"
  65.                 },
  66.                 "44ab36ebf4cf119edaf2d20401da87e4": {
  67.                     "is_default": false,
  68.                     "source": "631b6576cc5dfbdcaa4f510ce88a7e67",
  69.                     "id": "44ab36ebf4cf119edaf2d20401da87e4",
  70.                     "target": "60c81e383d048d8a3c574d3436e1b82c"
  71.                 }
  72.             },
  73.             "start_event": {
  74.                 "type": "EmptyStartEvent",
  75.                 "outgoing": "fb2f3a8b533ca5c67e2440b4164f7632",
  76.                 "incoming": "",
  77.                 "id": "48afea1016ab70ee37179fa0eb1e1a14",
  78.                 "name": ""
  79.             },
  80.             "constants": {
  81.                 "${script_type}": {
  82.                     "source_tag": "job_fast_execute_script.script_type",
  83.                     "source_info": {
  84.                         "631b6576cc5dfbdcaa4f510ce88a7e67": [
  85.                             "script_type"
  86.                         ]
  87.                     },
  88.                     "name": "脚本类型",
  89.                     "index": 0,
  90.                     "custom_type": "radio",
  91.                     "value": "4",
  92.                     "show_type": "show",
  93.                     "source_type": "component_inputs",
  94.                     "key": "${script_type}",
  95.                     "validation": "^.*$",
  96.                     "desc": ""
  97.                 },
  98.                 "${content}": {
  99.                     "source_tag": "",
  100.                     "source_info": {},
  101.                     "name": "内容",
  102.                     "index": 2,
  103.                     "custom_type": "textarea",
  104.                     "value": "",
  105.                     "show_type": "show",
  106.                     "source_type": "custom",
  107.                     "key": "${content}",
  108.                     "desc": ""
  109.                 },
  110.                 "${script_timeout}": {
  111.                     "source_tag": "job_fast_execute_script.script_timeout",
  112.                     "source_info": {
  113.                         "631b6576cc5dfbdcaa4f510ce88a7e67": [
  114.                             "script_timeout"
  115.                         ]
  116.                     },
  117.                     "name": "超时时间",
  118.                     "index": 1,
  119.                     "custom_type": "input",
  120.                     "value": "",
  121.                     "show_type": "show",
  122.                     "source_type": "component_inputs",
  123.                     "key": "${script_timeout}",
  124.                     "validation": "^.*$",
  125.                     "desc": ""
  126.                 },
  127.                 "${params}": {
  128.                     "source_tag": "",
  129.                     "source_info": {},
  130.                     "name": "参数",
  131.                     "index": 3,
  132.                     "custom_type": "input",
  133.                     "value": "",
  134.                     "show_type": "show",
  135.                     "source_type": "custom",
  136.                     "key": "${params}",
  137.                     "desc": ""
  138.                 }
  139.             },
  140.             "gateways": {}
  141.         },
  142.         "id": 30,
  143.         "editor": "admin"
  144.     },
  145. }

返回结果参数说明

字段 类型 描述
result bool true/false 查询成功与否
data dict result=true 时模板详情，详细信息见下面说明
message string result=false 时错误信息

data

字段 类型 描述
id int 模板ID
name string 模板名称
category string 模板分类，分类信息见下面说明
creator string 模板创建人
create_time string 模板创建时间
editor string 或者 null 模板编辑人
edit_time string 模板最新编辑时间
pipeline_tree dict 模板任务树信息，详细信息见下面说明

data.category

返回值 描述
OpsTools 运维工具
MonitorAlarm 监控告警
ConfManage 配置管理
DevTools 开发工具
EnterpriseIT 企业IT
OfficeApp 办公应用
Other 其它

data.pipeline_tree

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

data.pipeline_tree.constants KEY

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