通用参数

接口参数

字段 类型 必选 描述
project_id string 是 项目ID
scope string 否 bk_biz_id 检索的作用域。默认为 cmdb_biz，此时检索的是绑定的 CMDB 业务 ID 为 project_id 的项目；当值为 project 时则检索项目 ID 为 project_id 的项目 
  2.     "data": [
  3.         {
  4.             "inputs": [
  5.                 {
  6.                     "required": true,
  7.                     "type": "string",
  8.                     "name": "业务 ID",
  9.                     "key": "biz_cc_id",
  10.                     "schema": {
  11.                         "enum": [],
  12.                         "type": "string",
  13.                         "description": "当前操作所属的 CMDB 业务 ID"
  14.                     }
  15.                 },
  16.                 {
  17.                     "required": true,
  18.                     "type": "string",
  19.                     "name": "定时作业名称",
  20.                     "key": "job_cron_name",
  21.                     "schema": {
  22.                         "enum": [],
  23.                         "type": "string",
  24.                         "description": "待创建的定时作业名称"
  25.                     }
  26.                 },
  27.                 {
  28.                     "required": true,
  29.                     "type": "string",
  30.                     "name": "定时规则",
  31.                     "key": "job_cron_expression",
  32.                     "schema": {
  33.                         "enum": [],
  34.                         "type": "string",
  35.                         "description": "待创建的定时作业定时规则"
  36.                     }
  37.                 },
  38.                 {
  39.                     "required": true,
  40.                     "type": "string",
  41.                     "name": "定时作业状态",
  42.                     "key": "job_cron_status",
  43.                     "schema": {
  44.                         "enum": [
  45.                             1,
  46.                             2
  47.                         ],
  48.                         "type": "int",
  49.                         "description": "待创建的定时作业状态，暂停(1) 启动(2)"
  50.                     }
  51.             ],
  52.             "code": "job_cron_task",
  53.             "name": "新建定时作业",
  54.             "group_name": "作业平台(JOB)",
  55.             "output": [
  56.                 {
  57.                     "type": "int",
  59.                     "key": "cron_id",
  60.                     "schema": {
  61.                         "enum": [],
  62.                         "type": "int",
  63.                         "description": "成功创建的定时作业 ID"
  64.                     }
  65.                 },
  66.                 {
  67.                     "type": "string",
  68.                     "name": "定时作业状态",
  69.                     "key": "status",
  70.                     "schema": {
  71.                         "enum": [],
  72.                         "type": "string",
  73.                         "description": "成功创建的定时作业状态"
  74.                     }
  75.                 },
  76.                 {
  77.                     "type": "bool",
  78.                     "name": "执行结果",
  79.                     "key": "_result",
  80.                     "schema": {
  81.                         "enum": [],
  82.                         "type": "boolean",
  83.                         "description": "是否执行成功"
  84.                     }
  85.                 }
  86.             ],
  87.             "desc": ""
  88.         },
  89.         {
  90.             "inputs": [
  91.                 {
  92.                     "required": true,
  93.                     "type": "string",
  94.                     "name": "业务 ID",
  95.                     "key": "biz_cc_id",
  96.                     "schema": {
  97.                         "enum": [],
  98.                         "type": "string",
  99.                         "description": "当前操作所属的 CMDB 业务 ID"
  100.                     }
  101.                 },
  102.                 {
  103.                     "required": true,
  104.                     "type": "string",
  105.                     "name": "主机 IP",
  106.                     "key": "cc_host_ip",
  107.                     "schema": {
  108.                         "enum": [],
  109.                         "type": "string",
  110.                         "description": "转移到资源池的主机内网 IP，多个以 \",\" 分隔"
  111.                     }
  112.             ],
  113.             "code": "cmdb_transfer_host_resource",
  114.             "name": "转移主机至资源池",
  116.             "output": [
  117.                 {
  118.                     "type": "bool",
  119.                     "name": "执行结果",
  120.                     "key": "_result",
  121.                     "schema": {
  122.                         "enum": [],
  123.                         "type": "boolean",
  124.                         "description": "是否执行成功"
  125.                     }
  126.                 }
  127.             ],
  128.             "desc": ""
  129.         },
  130.         {
  131.             "inputs": [
  132.                 {
  133.                     "required": true,
  134.                     "type": "string",
  135.                     "name": "业务 ID",
  136.                     "key": "biz_cc_id",
  137.                     "schema": {
  138.                         "enum": [],
  139.                         "type": "string",
  140.                         "description": "当前操作所属的 CMDB 业务 ID"
  141.                     }
  142.                 },
  143.                 {
  144.                     "required": true,
  145.                     "type": "string",
  146.                     "name": "主机 IP",
  147.                     "key": "cc_host_ip",
  148.                     "schema": {
  149.                         "enum": [],
  150.                         "type": "string",
  151.                         "description": "转移到故障机的主机内网 IP，多个以 \",\" 分隔"
  152.                     }
  153.                 }
  154.             ],
  155.             "code": "cmdb_transfer_fault_host",
  156.             "name": "转移主机到业务的故障机模块",
  157.             "group_name": "配置平台(CMDB)",
  158.             "output": [
  159.                 {
  160.                     "type": "bool",
  161.                     "name": "执行结果",
  162.                     "key": "_result",
  163.                     "schema": {
  164.                         "enum": [],
  165.                         "type": "boolean",
  166.                         "description": "是否执行成功"
  167.                     }
  168.                 }
  169.             ],
  170.             "desc": ""
  171.         }
  172.     ],
  173. }

data

名称 类型 说明
inputs list 插件的输入参数
code string 插件的编码
name string 插件名
group_name string 插件所属的组名
outputs list 插件的输出参数
desc string 插件描述
inputs
inputs.schema
名称 类型 说明
type string 参数类型
enum list 参数可选范围
description string 参数描述
properties dict 对象属性 schema，当 type 为 object 时，会存在该字段，该对象的属性的值为另一个 schema 对象
items dict 列表元素 schema，当 type 为 array 时，会存在该字段
outputs
outputs.schema
名称 类型 说明
type string 参数类型
enum list 参数可选范围
description string 参数描述
properties dict 对象属性 schema，当 type 为 object 时，会存在该字段，该对象的属性的值为另一个 schema 对象
items dict 列表元素 schema，当 type 为 array 时，会存在该字段