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

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

Python

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

Ruby

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

Js

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

コンソール

  1. GET /_index_template/template_1

リクエスト

GET /_index_template/<index-template>

前提条件

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

パスパラメータ

(オプション、文字列) 返すテンプレートの名前。ワイルドカード式を受け入れます。省略した場合、すべてのテンプレートが返されます。

クエリパラメータ

  • flat_settings
  • (オプション、ブール値) trueの場合、設定をフラット形式で返します。デフォルトはfalseです。
  • local
  • (オプション、ブール値) trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、マスターノードから情報を取得します。
  • master_timeout
  • (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • include_defaults
  • (オプション、ブール値) [プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . trueの場合、レスポンスにすべてのデフォルト設定を返します。デフォルトはfalseです。

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

Python

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

Ruby

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

Js

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

コンソール

  1. GET /_index_template/temp*

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

Python

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

Ruby

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

Js

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

コンソール

  1. GET /_index_template