cat コンポーネントテンプレート API

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

クラスター内の component templates に関する情報を返します。コンポーネントテンプレートは、インデックス mappings、settings、および aliases を指定する index templates を構築するためのビルディングブロックです。

リクエスト

GET /_cat/component_templates/<template_name>

GET /_cat/component_templates

前提条件

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

パスパラメータ

  • <template_name>
  • （オプション、文字列）返すコンポーネントテンプレートの名前。ワイルドカード式を受け入れます。省略した場合、すべてのコンポーネントテンプレートが返されます。

クエリパラメータ

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

例

Python

  1. resp = client.cat.component_templates(
  2.    name="my-template-*",
  3.    v=True,
  4.    s="name",
  5. )
  6. print(resp)

Ruby

  1. response = client.cat.component_templates(
  2.   name: 'my-template-*',
  3.   v: true,
  4.   s: 'name'
  5. )
  6. puts response

Js

  1. const response = await client.cat.componentTemplates({
  2.   name: "my-template-*",
  3.   v: "true",
  4.   s: "name",
  5. });
  6. console.log(response);

コンソール

  1. GET _cat/component_templates/my-template-*?v=true&s=name

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

Txt

  1. name          version alias_count mapping_count settings_count metadata_count included_in
  2. my-template-1         0           0             1              0              [my-index-template]
  3. my-template-2         0           3             0              0              [my-index-template]