调用ListPlugins,获取指定阿里云Elasticsearch实例的插件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String es-cn-xxx

实例ID。

name String analysis-ik

插件名称。

page String 1

当前页数。

size Integer 10

每页记录数。

source String 系统默认

来源类型。

返回数据

名称 类型 示例值 描述
Headers

返回头信息。

X-Total-Count Integer 2

实例总记录数。

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

当前请求的Request ID。

Result

当前请求返回的插件列表。

description String IK analysis plug-in for Elasticsearch.

插件描述。

name String analysis-ik

插件名称。

source String SYSTEM

来源类型。

state String INSTALLED

插件状态。

示例

请求示例

GET /openapi/instances/[InstanceId]/plugins HTTP/1.1
公共请求头
{
  "InstanceId": "es-cn-xxx"
  "name": "analysis-ik"
  "page": "1"
  "size": 10
}

正常返回示例

XML 格式

<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 格式

{
	"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****"
}

错误码

访问错误中心查看更多错误码。