ListLogstashPlugins - Elasticsearch - Alibaba Cloud ドキュメントセンター

すべてのプラグインまたは指定されたプラグインの詳細情報をクエリします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。

リクエスト構文

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

リクエストパラメーター

パラメーター	タイプ	場所	必須	備考	説明
InstanceId	String	Path	Yes	ls-cn-oew1qbgl****	インスタンス ID。
name	String	Query	No	logstash-filter-clone	プラグインの名前。
page	Integer	Query	No	10	プラグインリストのページ数。デフォルト値：1。最小値：1。最大値：200。
size	Integer	Query	No	3	各ページに返すエントリの数。最小値：1。最大値：200。
source	String	Query	No	USER	プラグインのソース。有効な値： USER：カスタムプラグイン SYSTEM：システムプリセットプラグイン

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	99407AB-2FA9-489E-A259-40CF6DCC****	リクエスト ID。
Result	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
  }
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。