文档

ListKibanaPlugins

获取Elasticsearch Kibana节点的插件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/instances/{InstanceId}/kibana-plugins HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

InstanceId String Path es-cn-oew1q8bev0002****

实例ID。

page String Query 1

实例列表的页码。默认值:1。

size Integer Query 10

分页查询时设置的每页条数。

返回数据

名称

类型

示例值

描述

RequestId String 11234B4A-34CE-473B-8E61-AD95702E****

请求ID。

Headers Object

请求头。

X-Total-Count Integer 3

返回的数据条数。

Result Array of PluginItem

当前请求返回的插件信息。

description String Customize DSL statements to query data.

插件描述。

specificationUrl String https://xxxx

插件简介地址,支持null。

state String INSTALLED

插件安装状态。返回值如下:

  • INSTALLED:已安装
  • UNINSTALLED:未安装
  • INSTALLING:安装中
  • UNINSTALLING:卸载中
  • UPGRADING:升级中
  • FAILED:安装失败
  • UNKNOWN:集群失联无法获取到创建状态
source String SYSTEM

插件来源。返回值如下:

  • USER:自定义插件
  • SYSTEM:系统预置插件
name String bsearch_querybuilder

插件名称。

示例

请求示例

GET /openapi/instances/es-cn-oew1q8bev0002****/kibana-plugins?page=1&size=10 HTTP/1.1
公共请求头

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "name" : "bsearch_label",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "Mark data in a visual way to complete the query tasks quickly and easily.",
    "specificationUrl" : "https://xxx.html"
  }, {
    "name" : "bsearch_querybuilder",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "Customize DSL statements to query data.",
    "specificationUrl" : "https://xxx.html"
  }, {
    "name" : "network_vis",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "This is a plugin developed for Kibana that displays a network node that link two fields that have been previously selected."
  } ],
  "RequestId" : "11234B4A-34CE-473B-8E61-AD95702E****",
  "Headers" : {
    "X-Total-Count" : 3
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈