インデックステンプレートAPIの取得
このドキュメントは、非推奨のレガシーインデックステンプレートについてです。これらは、Elasticsearch 7.8で導入されたコンポーザブルテンプレートに置き換えられます。コンポーザブルテンプレートに関する情報は、インデックステンプレートを参照してください。
1つ以上のインデックステンプレートに関する情報を取得します。
Python
resp = client.indices.get_template(
name="template_1",
)
print(resp)
Ruby
response = client.indices.get_template(
name: 'template_1'
)
puts response
Js
const response = await client.indices.getTemplate({
name: "template_1",
});
console.log(response);
コンソール
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
resp = client.indices.get_template(
name="template_1,template_2",
)
print(resp)
Ruby
response = client.indices.get_template(
name: 'template_1,template_2'
)
puts response
Js
const response = await client.indices.getTemplate({
name: "template_1,template_2",
});
console.log(response);
コンソール
GET /_template/template_1,template_2
ワイルドカード式を使用してインデックステンプレートを取得
Python
resp = client.indices.get_template(
name="temp*",
)
print(resp)
Ruby
response = client.indices.get_template(
name: 'temp*'
)
puts response
Js
const response = await client.indices.getTemplate({
name: "temp*",
});
console.log(response);
コンソール
GET /_template/temp*
すべてのインデックステンプレートの取得
Python
resp = client.indices.get_template()
print(resp)
Ruby
response = client.indices.get_template
puts response
Js
const response = await client.indices.getTemplate();
console.log(response);
コンソール
GET /_template