ListPlugins - 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 for different SDKs.

Request headers

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

Request syntax

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

Request parameters


Parameter	Type	Position	Required	Example	Description
InstanceId	String	Path	Yes	es-cn-nif1q9o8r0008****	The ID of the instance.
name	String	Query	No	analysis-ik	The name of the plug-in.
page	String	Query	No	1	The number of the returned page.
size	Integer	Query	No	10	The number of entries returned per page.
source	String	Query	No	SYSTEM	The source type of the plug-in. Only SYSTEM is supported.

Response parameters


Parameter	Type	Example	Description
RequestId	String	5A5D8E74-565C-43DC-B031-29289FA9****	The ID of the request.
Headers	Object		The header of the response.
X-Total-Count	Integer	2	The total number of entries returned.
Result	Array of Result		The return results.
description	String	IK analysis plug-in for Elasticsearch.	The description of the plug-in.
specificationUrl	String	https://xxxx.html	The address of the plug-in description document.
state	String	INSTALLED	The status of the plug-in.
source	String	SYSTEM	The source type of the plug-in.
name	String	analysis-ik	The name of the plug-in.

Examples

Sample requests

GET /openapi/instances/es-cn-nif1q9o8r0008****/plugins?source=SYSTEM 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" : "aliyun-qos",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Rate limiting and throttling plug-in for Elasticsearch. It limits QPS and bulk request sizes and supports rate limiting and throttling for node-level read and write operations.",
    "specificationUrl" : "https://xxxx.html"
  }, {
    "name" : "aliyun-sql",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "SQL plug-in developed by Alibaba Cloud for Elasticsearch. It provides high SQL query capabilities.",
    "specificationUrl" : "https://xxxx.html"
  }, {
    "name" : "analysis-aliws",
    "state" : "UNINSTALLED",
    "source" : "SYSTEM",
    "description" : "Aliws analysis plug-in for Elasticsearch. It is integrated with an analyzer and a tokenizer.",
    "specificationUrl" : "https://xxxx.html"
  }, {
    "name" : "analysis-icu",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "ICU analysis plug-in for Elasticsearch. It integrates the Lucene ICU module into Elasticsearch and adds ICU analysis components."
  }, {
    "name" : "analysis-ik",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "IK analysis plug-in for Elasticsearch."
  }, {
    "name" : "analysis-kuromoji",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Japanese (Kuromoji) analysis plug-in for Elasticsearch. It integrates the Lucene Kuromoji analysis module into Elasticsearch."
  }, {
    "name" : "analysis-phonetic",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Phonetic analysis plug-in for Elasticsearch. It integrates the phonetic token filter into Elasticsearch."
  }, {
    "name" : "analysis-pinyin",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Pinyin analysis plug-in for Elasticsearch."
  }, {
    "name" : "analysis-smartcn",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Smart Chinese analysis plug-in for Elasticsearch. It integrates the Lucene Smart Chinese analysis module into Elasticsearch."
  }, {
    "name" : "apack",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Provides the general physical replication and vector retrieval features. These features improve the write performance of a cluster and enable image search.",
    "specificationUrl" : "https://xxxx.html"
  }, {
    "name" : "codec-compression",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The codec-compression plug-in supports lossless compression algorithms such as Brotli and zstd. This plug-in also provides a high index compression ratio and reduces index storage costs.",
    "specificationUrl" : "https://xxxx.html"
  }, {
    "name" : "elasticsearch-repository-oss",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Alibaba Cloud OSS is supported for storing Elasticsearch snapshots."
  }, {
    "name" : "ingest-attachment",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Ingest processor for Elasticsearch. It uses Apache Tika to extract content."
  }, {
    "name" : "kmonitor",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "aliyun elasticsearch kmonitor plugin"
  }, {
    "name" : "mapper-murmur3",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "Computes the hashes of field values when an index is created and stores the hashes in the index."
  }, {
    "name" : "mapper-size",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The Mapper Size plug-in allows documents to record their uncompressed size at index time."
  }, {
    "name" : "repository-hdfs",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The HDFS repository plug-in adds support for Hadoop Distributed File System (HDFS) repositories."
  } ],
  "RequestId" : "06280628-C7CB-4818-83EE-8079ACB8****",
  "Headers" : {
    "X-Total-Count" : 17
  }
}

Error codes

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