catエイリアス（cat aliases）

cat aliases API

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

クラスターのindex aliasesを取得し、フィルターおよびルーティング情報を含みます。このAPIはデータストリームのエイリアスを返しません。

Request

GET _cat/aliases/<alias>

GET _cat/aliases

Prerequisites

• Elasticsearchのセキュリティ機能が有効になっている場合、取得するエイリアスに対してview_index_metadataまたはmanageindex privilegeを持っている必要があります。

Path parameters

• <alias>
• （オプション、文字列）取得するエイリアスのカンマ区切りリスト。ワイルドカード(*)をサポートします。すべてのエイリアスを取得するには、このパラメータを省略するか、*または_allを使用します。

Query parameters

• format
• （オプション、文字列）HTTP accept headerの短縮版。妥当な値にはJSON、YAMLなどが含まれます。
• h
• （オプション、文字列）表示する列名のカンマ区切りリスト。
• help
• （オプション、Boolean）trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
• local
• （オプション、Boolean）trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、マスターノードから情報を取得します。
• s
• （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
• v
• （オプション、Boolean）trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。
• expand_wildcards
• （オプション、文字列）ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームをターゲットにできる場合、この引数はワイルドカード式が隠されたデータストリームに一致するかどうかを決定します。カンマ区切りの値をサポートします。例えばopen,hidden。妥当な値は次のとおりです：
  • all
  • すべてのデータストリームまたはインデックスに一致します。隠されたものも含まれます。hidden
  • open
  • 開いている非隠蔽インデックスに一致します。また、非隠蔽データストリームにも一致します。
  • closed
  • 閉じた非隠蔽インデックスに一致します。また、非隠蔽データストリームにも一致します。データストリームは閉じることができません。
  • hidden
  • 隠されたデータストリームと隠されたインデックスに一致します。open、closed、またはその両方と組み合わせる必要があります。
  • none
  • ワイルドカードパターンは受け入れられません。

Examples

Python

resp = client.cat.aliases(
   v=True,
)
print(resp)

Ruby

response = client.cat.aliases(
  v: true
)
puts response

Js

const response = await client.cat.aliases({
  v: "true",
});
console.log(response);

Console

GET _cat/aliases?v=true

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

Txt

alias  index filter routing.index routing.search is_write_index
alias1 test1 -      -            -              -
alias2 test1 *      -            -              -
alias3 test1 -      1            1              -
alias4 test1 -      2            1,2            -

このレスポンスは、alias2がフィルターを設定し、alias3およびalias4に特定のルーティング構成を持っていることを示しています。

特定のエイリアスに関する情報のみを取得したい場合は、エイリアスをカンマ区切り形式でURLパラメータとして指定できます。例：/_cat/aliases/alias1,alias2。