インデックステンプレートAPIの取得
1つ以上のインデックステンプレートに関する情報を返します。
Python
resp = client.indices.get_index_template(
name="template_1",
)
print(resp)
Ruby
response = client.indices.get_index_template(
name: 'template_1'
)
puts response
Js
const response = await client.indices.getIndexTemplate({
name: "template_1",
});
console.log(response);
コンソール
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
resp = client.indices.get_index_template(
name="temp*",
)
print(resp)
Ruby
response = client.indices.get_index_template(
name: 'temp*'
)
puts response
Js
const response = await client.indices.getIndexTemplate({
name: "temp*",
});
console.log(response);
コンソール
GET /_index_template/temp*
すべてのインデックステンプレートを取得
Python
resp = client.indices.get_index_template()
print(resp)
Ruby
response = client.indices.get_index_template
puts response
Js
const response = await client.indices.getIndexTemplate();
console.log(response);
コンソール
GET /_index_template