catテンプレート（cat templates）

cat templates API

cat APIsは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、get index template APIを使用してください。

クラスター内のindex templatesに関する情報を返します。インデックステンプレートを使用して、新しいインデックスの作成時にindex settingsやfield mappingsを適用できます。

Request

GET /_cat/templates/<template_name>

GET /_cat/templates

Prerequisites

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage cluster privilegeが必要です。

Path parameters

• <template_name>
• (オプション、文字列) 返すテンプレートの名前。ワイルドカード式を受け入れます。省略した場合、すべてのテンプレートが返されます。

Query parameters

• format
• (オプション、文字列) HTTP accept headerの短縮版。妥当な値にはJSON、YAMLなどが含まれます。
• h
• (オプション、文字列) 表示する列名のカンマ区切りリスト。
• help
• (オプション、Boolean) trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
• local
• (オプション、Boolean) trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
• master_timeout
• (オプション、time units) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
• s
• (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
• v
• (オプション、Boolean) trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Python

resp = client.cat.templates(
   name="my-template-*",
   v=True,
   s="name",
)
print(resp)

Ruby

response = client.cat.templates(
  name: 'my-template-*',
  v: true,
  s: 'name'
)
puts response

Js

const response = await client.cat.templates({
  name: "my-template-*",
  v: "true",
  s: "name",
});
console.log(response);

Console

GET _cat/templates/my-template-*?v=true&s=name

APIは次のレスポンスを返します:

Txt

name          index_patterns order version composed_of
my-template-0 [te*]          500           []
my-template-1 [tea*]         501           []
my-template-2 [teak*]        502   7       []