コンポーネントテンプレートを取得（Get component template）

コンポーネントテンプレートAPIの取得

1つ以上のコンポーネントテンプレートに関する情報を取得します。

Python

resp = client.cluster.get_component_template(
   name="template_1",
)
print(resp)

Ruby

response = client.cluster.get_component_template(
  name: 'template_1'
)
puts response

Js

const response = await client.cluster.getComponentTemplate({
  name: "template_1",
});
console.log(response);

コンソール

GET /_component_template/template_1

リクエスト

GET /_component_template/<component-template>

前提条件

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

パスパラメータ

• <component-template>
• （オプション、文字列）リクエストを制限するために使用されるコンポーネントテンプレート名のカンマ区切りリスト。ワイルドカード（*）式がサポートされています。

クエリパラメータ

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

例

ワイルドカード式を使用してコンポーネントテンプレートを取得

Python

resp = client.cluster.get_component_template(
   name="temp*",
)
print(resp)

Ruby

response = client.cluster.get_component_template(
  name: 'temp*'
)
puts response

Js

const response = await client.cluster.getComponentTemplate({
  name: "temp*",
});
console.log(response);

コンソール

GET /_component_template/temp*

すべてのコンポーネントテンプレートを取得

Python

resp = client.cluster.get_component_template()
print(resp)

Ruby

response = client.cluster.get_component_template
puts response

Js

const response = await client.cluster.getComponentTemplate();
console.log(response);

コンソール

GET /_component_template