インデックステンプレートAPIの取得

このドキュメントは、非推奨のレガシーインデックステンプレートについてです。これらは、Elasticsearch 7.8で導入されたコンポーザブルテンプレートに置き換えられます。コンポーザブルテンプレートに関する情報は、インデックステンプレートを参照してください。

1つ以上のインデックステンプレートに関する情報を取得します。

Python

  1. resp = client.indices.get_template(
  2. name="template_1",
  3. )
  4. print(resp)

Ruby

  1. response = client.indices.get_template(
  2. name: 'template_1'
  3. )
  4. puts response

Js

  1. const response = await client.indices.getTemplate({
  2. name: "template_1",
  3. });
  4. console.log(response);

コンソール

  1. GET /_template/template_1

リクエスト

GET /_template/<index-template>

前提条件

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

パスパラメータ

  • <index-template>
  • (必須、文字列)リクエストを制限するために使用されるインデックステンプレート名のカンマ区切りリスト。ワイルドカード(*)式がサポートされています。
    すべてのインデックステンプレートを返すには、このパラメータを省略するか、_allまたは*の値を使用します。

クエリパラメータ

  • flat_settings
  • (オプション、ブール値)trueの場合、設定をフラット形式で返します。デフォルトはfalseです。
  • local
  • (オプション、ブール値)trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
  • master_timeout
  • (オプション、時間単位)マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

複数のインデックステンプレートの取得

Python

  1. resp = client.indices.get_template(
  2. name="template_1,template_2",
  3. )
  4. print(resp)

Ruby

  1. response = client.indices.get_template(
  2. name: 'template_1,template_2'
  3. )
  4. puts response

Js

  1. const response = await client.indices.getTemplate({
  2. name: "template_1,template_2",
  3. });
  4. console.log(response);

コンソール

  1. GET /_template/template_1,template_2

ワイルドカード式を使用してインデックステンプレートを取得

Python

  1. resp = client.indices.get_template(
  2. name="temp*",
  3. )
  4. print(resp)

Ruby

  1. response = client.indices.get_template(
  2. name: 'temp*'
  3. )
  4. puts response

Js

  1. const response = await client.indices.getTemplate({
  2. name: "temp*",
  3. });
  4. console.log(response);

コンソール

  1. GET /_template/temp*

すべてのインデックステンプレートの取得

Python

  1. resp = client.indices.get_template()
  2. print(resp)

Ruby

  1. response = client.indices.get_template
  2. puts response

Js

  1. const response = await client.indices.getTemplate();
  2. console.log(response);

コンソール

  1. GET /_template