ListLogstashPlugins - Elasticsearch

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

GET /openapi/logstashes/{InstanceId}/plugins HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	ls-cn-oew1qbgl****	執行個體ID。
name	String	Query	否	logstash-filter-clone	外掛程式名稱。
page	Integer	Query	否	10	外掛程式列表的分頁數。預設值：1，最小值：1，最大值：200。
size	Integer	Query	否	3	分頁查詢時設定的每頁條數。最小值：1，最大值：200。
source	String	Query	否	USER	外掛程式來源。可選值： USER：自訂外掛程式 SYSTEM：系統預置外掛程式

返回資料

名稱	類型	樣本值	描述
RequestId	String	99407AB-2FA9-489E-A259-40CF6DCC****	請求ID。
Result	Array of Result		返回結果。
description	String	The clone filter is for duplicating events.	外掛程式描述。
specificationUrl	String	https://xxx.html	外掛程式的說明文檔地址。
state	String	INSTALLED	外掛程式的狀態。支援： INSTALLED：已安裝 UNINSTALLED：未安裝 INSTALLING：安裝中 UNINSTALLING：卸載中 UPGRADING：升級中 FAILED：安裝失敗 UNKNOWN：叢集失聯無法擷取到建立狀態
source	String	SYSTEM	外掛程式來源。
name	String	logstash-filter-clone	外掛程式名稱。

返回資料中還包含以下參數。

名稱	類型	樣本值	描述
Headers	Struct		返回頭資訊。
└X-Total-Count	Integer	131	返回的外掛程式數量。

說明 └表示子參數。

樣本

請求樣本

GET /openapi/logstashes/ls-cn-oew1qbgl****/plugins?name=logstash-filter-clone&page=10&size=3&source=USER HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回樣本

JSON格式

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

{
  "Result" : [ {
    "name" : "logstash-filter-clone",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The clone filter is for duplicating events. A clone will be created for each type in the clone list.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-clone.html"
  }, {
    "name" : "logstash-filter-csv",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The CSV filter takes an event field containing CSV data, parses it, and stores it as individual fields (can optionally specify the names). This filter can also parse data with any separator, not just commas.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-csv.html"
  }, {
    "name" : "logstash-filter-date",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The date filter is used for parsing dates from fields, and then using that date or timestamp as the logstash timestamp for the event.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-date.html"
  } ],
  "RequestId" : "40C0570B-AB40-48BA-8CAE-66EA230A****",
  "Headers" : {
    "X-Total-Count" : 131
  }
}

錯誤碼

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