インデックステンプレート存在API
このドキュメントは、レガシーインデックステンプレートに関するもので、これは非推奨であり、Elasticsearch 7.8で導入されたコンポーザブルテンプレートに置き換えられます。コンポーザブルテンプレートに関する情報は、インデックステンプレートを参照してください。
レガシーインデックステンプレートが存在するかどうかを確認します。
Python
resp = client.indices.exists_template(
name="template_1",
)
print(resp)
Ruby
response = client.indices.exists_template(
name: 'template_1'
)
puts response
Js
const response = await client.indices.existsTemplate({
name: "template_1",
});
console.log(response);
コンソール
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つ以上のインデックステンプレートが存在しないことを示します。