インデックステンプレート存在API

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

レガシーインデックステンプレートが存在するかどうかを確認します。

Python

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

Ruby

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

Js

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

コンソール

  1. HEAD /_template/template_1

リクエスト

HEAD /_template/<index-template>

前提条件

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

説明

インデックステンプレート存在APIを使用して、1つ以上のインデックステンプレートが存在するかどうかを判断します。

インデックステンプレートは、設定マッピング、およびエイリアスを定義し、新しいインデックスに自動的に適用できます。

パスパラメータ

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

クエリパラメータ

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

レスポンスコード

  • 200
  • 指定されたすべてのインデックステンプレートが存在することを示します。
  • 404
  • 指定された1つ以上のインデックステンプレートが存在しないことを示します。