全部產品
Search
文件中心

Elasticsearch:ListKibanaPlugins

更新時間:Jan 15, 2025

擷取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
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。