功能描述

查询某个项目下的插件列表

请求参数

通用参数

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

接口参数

字段 类型 必选 描述
project_id string 是 项目ID
scope string 否 bk_biz_id 检索的作用域。默认为 cmdb_biz，此时检索的是绑定的 CMDB 业务 ID 为 project_id 的项目；当值为 project 时则检索项目 ID 为 project_id 的项目

请求参数示例

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

返回结果示例

  1. {
  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.             ],
  53.             "code": "job_cron_task",
  54.             "name": "新建定时作业",
  55.             "group_name": "作业平台(JOB)",
  56.             "output": [
  57.                 {
  58.                     "type": "int",
  59.                     "name": "定时作业ID",
  60.                     "key": "cron_id",
  61.                     "schema": {
  62.                         "enum": [],
  63.                         "type": "int",
  64.                         "description": "成功创建的定时作业 ID"
  65.                     }
  66.                 },
  67.                 {
  68.                     "type": "string",
  69.                     "name": "定时作业状态",
  70.                     "key": "status",
  71.                     "schema": {
  72.                         "enum": [],
  73.                         "type": "string",
  74.                         "description": "成功创建的定时作业状态"
  75.                     }
  76.                 },
  77.                 {
  78.                     "type": "bool",
  79.                     "name": "执行结果",
  80.                     "key": "_result",
  81.                     "schema": {
  82.                         "enum": [],
  83.                         "type": "boolean",
  84.                         "description": "是否执行成功"
  85.                     }
  86.                 }
  87.             ],
  88.             "desc": ""
  89.         },
  90.         {
  91.             "inputs": [
  92.                 {
  93.                     "required": true,
  94.                     "type": "string",
  95.                     "name": "业务 ID",
  96.                     "key": "biz_cc_id",
  97.                     "schema": {
  98.                         "enum": [],
  99.                         "type": "string",
  100.                         "description": "当前操作所属的 CMDB 业务 ID"
  101.                     }
  102.                 },
  103.                 {
  104.                     "required": true,
  105.                     "type": "string",
  106.                     "name": "主机 IP",
  107.                     "key": "cc_host_ip",
  108.                     "schema": {
  109.                         "enum": [],
  110.                         "type": "string",
  111.                         "description": "转移到资源池的主机内网 IP，多个以 \",\" 分隔"
  112.                     }
  113.                 }
  114.             ],
  115.             "code": "cmdb_transfer_host_resource",
  116.             "name": "转移主机至资源池",
  117.             "group_name": "配置平台(CMDB)",
  118.             "output": [
  119.                 {
  120.                     "type": "bool",
  121.                     "name": "执行结果",
  122.                     "key": "_result",
  123.                     "schema": {
  124.                         "enum": [],
  125.                         "type": "boolean",
  126.                         "description": "是否执行成功"
  127.                     }
  128.                 }
  129.             ],
  130.             "desc": ""
  131.         },
  132.         {
  133.             "inputs": [
  134.                 {
  135.                     "required": true,
  136.                     "type": "string",
  137.                     "name": "业务 ID",
  138.                     "key": "biz_cc_id",
  139.                     "schema": {
  140.                         "enum": [],
  141.                         "type": "string",
  142.                         "description": "当前操作所属的 CMDB 业务 ID"
  143.                     }
  144.                 },
  145.                 {
  146.                     "required": true,
  147.                     "type": "string",
  148.                     "name": "主机 IP",
  149.                     "key": "cc_host_ip",
  150.                     "schema": {
  151.                         "enum": [],
  152.                         "type": "string",
  153.                         "description": "转移到故障机的主机内网 IP，多个以 \",\" 分隔"
  154.                     }
  155.                 }
  156.             ],
  157.             "code": "cmdb_transfer_fault_host",
  158.             "name": "转移主机到业务的故障机模块",
  159.             "group_name": "配置平台(CMDB)",
  160.             "output": [
  161.                 {
  162.                     "type": "bool",
  163.                     "name": "执行结果",
  164.                     "key": "_result",
  165.                     "schema": {
  166.                         "enum": [],
  167.                         "type": "boolean",
  168.                         "description": "是否执行成功"
  169.                     }
  170.                 }
  171.             ],
  172.             "desc": ""
  173.         }
  174.     ],
  175.     "result": true
  176. }

返回结果参数说明

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

data

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