You can call this operation to query plug-ins on a specified Elasticsearch instance.

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 header

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

Request syntax

GET /openapi/instances/[InstanceId]/plugins HTTP/1.1

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-xxx

The ID of the instance.

name String No analysis-ik

The name of the plug-in.

page String Yes 1

The number of the page to return.

size Integer Yes 10

The number of entries to return on each page.

source String No SYSTEM

The type of plug-ins.

Response parameters

Parameter Type Example Description
Headers

The header of the response.

X-Total-Count Integer 2

The number of entries returned.

RequestId String 5A5D8E74-565C-43DC-B031-29289FA9****

The ID of the request.

Result

The returned plug-in information.

description String IK analysis plug-in for Elasticsearch.

The description of the plug-in.

name String analysis-ik

The name of the plug-in.

source String SYSTEM

The type of the plug-in.

state String INSTALLED

The status of the plug-in.

Examples

Sample requests

GET /openapi/instances/[InstanceId]/plugins HTTP/1.1
Common request header
{
  "InstanceId": "es-cn-xxx"
  "name": "analysis-ik"
  "page": "1"
  "size": 10
}

Sample success responses

XML format

<Result>
    <name>analysis-icu</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>ICU analysis plug-in that integrates the Lucene ICU module into Elasticsearch and adds ICU analysis components.</description>
</Result>
<Result>
    <name>analysis-ik</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>IK analysis plug-in for Elasticsearch.</description>
</Result>
<Result>
    <name>analysis-kuromoji</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Japanese (Kuromoji) analysis plug-in that integrates the Lucene Kuromoji analysis module into Elasticsearch.</description>
</Result>
<Result>
    <name>analysis-phonetic</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Phonetic analysis plug-in that integrates the phonetic token filter into Elasticsearch.</description>
</Result>
<Result>
    <name>analysis-pinyin</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Pinyin analysis plug-in for Elasticsearch.</description>
</Result>
<Result>
    <name>analysis-smartcn</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Smart Chinese analysis plug-in that integrates the Lucene Smart Chinese analysis module into Elasticsearch.</description>
</Result>
<Result>
    <name>elasticsearch-repository-oss</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Alibaba Cloud OSS is supported for storing Elasticsearch snapshots.</description>
</Result>
<Result>
    <name>ingest-attachment</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Ingest processor that uses Apache Tika to extract contents.</description>
</Result>
<Result>
    <name>ingest-geoip</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Ingest processor that queries geo data in MaxMind geo databases based on IP addresses.</description>
</Result>
<Result>
    <name>ingest-user-agent</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Ingest processor that extracts information from a user agent.</description>
</Result>
<Result>
    <name>mapper-attachments</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>The mapper attachments plugin adds the attachment type to Elasticsearch using Apache Tika.</description>
</Result>
<Result>
    <name>mapper-murmur3</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>The Mapper Murmur3 plug-in allows you to compute the hashes of a field's values at index time and store them in the index.</description>
</Result>
<Result>
    <name>mapper-size</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>The Mapper Size plug-in allows documents to record their uncompressed size at index time.</description>
</Result>
<Result>
    <name>repository-hdfs</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>The HDFS repository plug-in adds support for Hadoop Distributed File System (HDFS) repositories.</description>
</Result>
<Result>
    <name>sql</name>
    <state>UNINSTALLED</state>
    <source>SYSTEM</source>
    <description>Query elasticsearch using SQL</description>
</Result>
<Result>
    <name>x-pack</name>
    <state>INSTALLED</state>
    <source>SYSTEM</source>
    <description>Elasticsearch Expanded Pack Plugin</description>
</Result>
<RequestId>5A5D8E74-565C-43DC-B031-29289FA9****</RequestId>
<Headers>
    <X-Total-Count>16</X-Total-Count>
</Headers>

JSON format

{
	"Headers":{
		"X-Total-Count":16
	},
	"Result":[
		{
			"source":"SYSTEM",
			"description":"ICU analysis plug-in that integrates the Lucene ICU module into Elasticsearch and adds ICU analysis components.",
			"name":"analysis-icu",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"IK analysis plug-in for Elasticsearch.",
			"name":"analysis-ik",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Japanese (Kuromoji) analysis plug-in that integrates the Lucene Kuromoji analysis module into Elasticsearch.",
			"name":"analysis-kuromoji",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Phonetic analysis plug-in that integrates the phonetic token filter into Elasticsearch.",
			"name":"analysis-phonetic",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Pinyin analysis plug-in for Elasticsearch.",
			"name":"analysis-pinyin",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Smart Chinese analysis plug-in that integrates the Lucene Smart Chinese analysis module into Elasticsearch.",
			"name":"analysis-smartcn",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Alibaba Cloud OSS is supported for storing Elasticsearch snapshots.",
			"name":"elasticsearch-repository-oss",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Ingest processor that uses Apache Tika to extract contents.",
			"name":"ingest-attachment",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Ingest processor that queries geo data in MaxMind geo databases based on IP addresses.",
			"name":"ingest-geoip",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Ingest processor that extracts information from a user agent.",
			"name":"ingest-user-agent",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"The mapper attachments plugin adds the attachment type to Elasticsearch using Apache Tika.",
			"name":"mapper-attachments",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"The Mapper Murmur3 plug-in allows you to compute the hashes of a field's values at index time and store them in the index.",
			"name":"mapper-murmur3",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"The Mapper Size plug-in allows documents to record their uncompressed size at index time.",
			"name":"mapper-size",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"The HDFS repository plug-in adds support for Hadoop Distributed File System (HDFS) repositories.",
			"name":"repository-hdfs",
			"state":"INSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Query elasticsearch using SQL",
			"name":"sql",
			"state":"UNINSTALLED"
		},
		{
			"source":"SYSTEM",
			"description":"Elasticsearch Expanded Pack Plugin",
			"name":"x-pack",
			"state":"INSTALLED"
		}
	],
	"RequestId":"5A5D8E74-565C-43DC-B031-29289FA9****"
}

Error codes

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