获取默认和自定义插件列表
所有文档
menu

Elasticsearch BES

获取默认和自定义插件列表

产品详情自助选购

请求URI

POST /api/bes/cluster/plugin/info

请求头参数

参数名称 参数类型 是否必须 描述 示例值
x-Region String 区域 bj

请求体参数

请求体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
clusterId String 集群ID 807521220013723648

响应体参数

响应体字段数据结构说明

参数名称 参数类型 描述 示例值
success Boolean 操作是否成功 true
status Integer 状态码 200
result Result

Result字段数据结构说明

参数名称 参数类型 描述 示例值
plugins List 自定义插件列表
defaultPlugins List 系统默认插件列表

PluginsItem字段数据结构说明

参数名称 参数类型 描述 示例值
moduleType String 模块类型 es_node
pluginDesc String 插件描述 Baidu NLP中文分词插件
pluginName String 插件名称 xxx.zip
pluginStatus String 插件状态 UNINSTALLED

DefaultPluginsItem字段数据结构说明

参数名称 参数类型 描述 示例值
moduleType String 模块类型 es_node
pluginDesc String 插件描述 custom
pluginName String 插件名称 xxx.zip
pluginStatus String 插件状态 UNINSTALLED
pluginOperation PluginOperation 插件操作

PluginOperation字段数据结构说明

参数名称 参数类型 描述 示例值
enable Boolean 是否可操作 true
operation String 操作类型 uninstall
text String 操作名称 卸载

请求示例

POST /api/bes/cluster/plugin/info
<公共请求头>
x-Region: bj


{
	"clusterId": "644734225693675520"
}

响应示例

HTTP/1.1 200 OK
<公共响应头>

{
  "result" : {
    "defaultPlugins" : [ {
      "pluginDesc" : "custom",
      "moduleType" : "es_node",
      "pluginName" : "xxx.zip",
      "pluginOperation" : {
        "enable" : true,
        "text" : "卸载",
        "operation" : "uninstall"
      },
      "pluginStatus" : "UNINSTALLED"
    }, {
      "pluginDesc" : "custom",
      "moduleType" : "es_node",
      "pluginName" : "xxx.zip",
      "pluginOperation" : {
        "enable" : true,
        "text" : "卸载",
        "operation" : "uninstall"
      },
      "pluginStatus" : "UNINSTALLED"
    } ],
    "plugins" : [ {
      "pluginDesc" : "Baidu NLP中文分词插件",
      "moduleType" : "es_node",
      "pluginName" : "xxx.zip",
      "pluginStatus" : "UNINSTALLED"
    }, {
      "pluginDesc" : "Baidu NLP中文分词插件",
      "moduleType" : "es_node",
      "pluginName" : "xxx.zip",
      "pluginStatus" : "UNINSTALLED"
    } ]
  },
  "success" : true,
  "status" : 200
}

错误码

请参考通用错误码

上一篇
配置修改相关接口
下一篇
安装系统默认插件