ListPlugins - Elasticsearch

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

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

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	es-cn-nif1q9o8r0008****	執行個體ID。
name	String	Query	否	analysis-ik	外掛程式名稱。
page	String	Query	否	1	分頁數。
size	Integer	Query	否	10	每頁記錄數。
source	String	Query	否	SYSTEM	外掛程式來源類型，僅支援SYSTEM（系統外掛程式）。

返回資料

名稱	類型	樣本值	描述
RequestId	String	5A5D8E74-565C-43DC-B031-29289FA9****	請求ID。
Headers	Object		返回頭資訊。
X-Total-Count	Integer	2	返回的總記錄數。
Result	Array of Result		返回結果。
description	String	IK analysis plug-in for Elasticsearch.	外掛程式描述。
specificationUrl	String	https://xxxx.html	外掛程式說明文檔的地址。
state	String	INSTALLED	外掛程式狀態。
source	String	SYSTEM	外掛程式來源類型。
name	String	analysis-ik	外掛程式名稱。

樣本

請求樣本

GET /openapi/instances/es-cn-nif1q9o8r0008****/plugins?source=SYSTEM HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。