cat plugins API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、nodes info APIを使用してください。

クラスターの各ノードで実行されているプラグインのリストを返します。

Request

GET /_cat/plugins

Prerequisites

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

Query parameters

  • format
  • (オプション、文字列) HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
  • h
  • (オプション、文字列) 表示する列名のカンマ区切りリスト。
  • help
  • (オプション、Boolean) trueの場合、レスポンスにはヘルプ情報が含まれます。 デフォルトはfalseです。
  • local
  • (オプション、Boolean) trueの場合、リクエストはローカルノードからのみ情報を取得します。 デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
  • master_timeout
  • (オプション、時間単位) マスターノードを待機する期間。 タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。 デフォルトは30sです。 リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • s
  • (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • v
  • (オプション、Boolean) trueの場合、レスポンスには列見出しが含まれます。 デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.plugins(
  2.    v=True,
  3.    s="component",
  4.    h="name,component,version,description",
  5. )
  6. print(resp)

Ruby

  1. response = client.cat.plugins(
  2.   v: true,
  3.   s: 'component',
  4.   h: 'name,component,version,description'
  5. )
  6. puts response

Js

  1. const response = await client.cat.plugins({
  2.   v: "true",
  3.   s: "component",
  4.   h: "name,component,version,description",
  5. });
  6. console.log(response);

Console

  1. GET /_cat/plugins?v=true&s=component&h=name,component,version,description

APIは次のレスポンスを返します：

Txt

  1. name    component               version   description
  2. U7321H6 analysis-icu            8.15.2 The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.
  3. U7321H6 analysis-kuromoji       8.15.2 The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.
  4. U7321H6 analysis-nori           8.15.2 The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.
  5. U7321H6 analysis-phonetic       8.15.2 The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.
  6. U7321H6 analysis-smartcn        8.15.2 Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.
  7. U7321H6 analysis-stempel        8.15.2 The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.
  8. U7321H6 analysis-ukrainian      8.15.2 The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.
  9. U7321H6 discovery-azure-classic 8.15.2 The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism
  10. U7321H6 discovery-ec2           8.15.2 The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.
  11. U7321H6 discovery-gce           8.15.2 The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.
  12. U7321H6 mapper-annotated-text   8.15.2 The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.
  13. U7321H6 mapper-murmur3          8.15.2 The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.
  14. U7321H6 mapper-size             8.15.2 The Mapper Size plugin allows document to record their uncompressed size at index time.
  15. U7321H6 store-smb               8.15.2 The Store SMB plugin adds support for SMB stores.