調用ListLogstashPlugins，獲取所有或指定插件的詳細信息。

調試

您可以在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
  }
}

錯誤碼

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