ListLogstashPlugins - Elasticsearch

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

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

Request parameters


Parameter	Type	Location	Required	Remarks	Description
InstanceId	String	Path	Yes	ls-cn-oew1qbgl****	The ID of the instance.
name	String	Query	No	logstash-filter-clone	The name of the plug-in.
page	Integer	Query	No	10	The number of pages in the plug-in list. Default value: 1. Minimum value: 1. Maximum value: 200.
size	Integer	Query	No	3	The number of entries to return on each page. Minimum value: 1. Maximum value: 200.
source	String	Query	No	USER	The source of the plug-in. Valid values: USER: custom plug-ins SYSTEM: a system preset plug-in

Response parameters


Parameter	Type	Example	Description
RequestId	String	99407AB-2FA9-489E-A259-40CF6DCC****	The ID of the request.
Result	Array of Result		The returned results.
description	String	The clone filter is for duplicating events.	The description of the plug-in.
specificationUrl	String	https://xxx.html	The address of the documentation for the plug-in.
state	String	INSTALLED	The status of the plug-in. Valid values: INSTALLED: Installed UNINSTALLED: Not installed INSTALLING: The instance is being installed. UNINSTALLING: The instance is being uninstalled. UPGRADING: The backup gateway is being upgraded. FAILED: Installation failed UNKNOWN: The cluster is lost and cannot be created.
source	String	SYSTEM	The source of the plug-in.
name	String	logstash-filter-clone	The name of the plug-in.

The returned data also contains the following parameters.


Parameter	Type	Example	Description
Headers	Struct		The header of the response.
└X-Total-Count	Integer	131	The number of returned plug-ins.

Note └ indicates a child parameter.

Examples

Sample requests

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

Sample success responses

JSON format

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

Error code

For a list of error codes, visit the API Error Center.