エイリアスAPIの取得

1つ以上のエイリアスに関する情報を取得します。

Python

  1. resp = client.indices.get_alias(
  2.    index="my-data-stream",
  3.    name="my-alias",
  4. )
  5. print(resp)

Ruby

  1. response = client.indices.get_alias(
  2.   index: 'my-data-stream',
  3.   name: 'my-alias'
  4. )
  5. puts response

Js

  1. const response = await client.indices.getAlias({
  2.   index: "my-data-stream",
  3.   name: "my-alias",
  4. });
  5. console.log(response);

コンソール

  1. GET my-data-stream/_alias/my-alias

リクエスト

GET _alias/<alias>

GET _alias

GET <target>/_alias/<alias>

前提条件

  • Elasticsearchのセキュリティ機能が有効になっている場合、エイリアスに対してview_index_metadataまたはmanageインデックス権限を持っている必要があります。ターゲットを指定する場合、ターゲットに対してview_index_metadataまたはmanageインデックス権限も必要です。

パスパラメータ

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

クエリパラメータ

  • allow_no_indices
  • （オプション、ブール値）falseの場合、リクエストは、ワイルドカード式、インデックスエイリアスまたは_allの値が欠落または閉じたインデックスのみをターゲットにする場合にエラーを返します。この動作は、リクエストが他のオープンインデックスをターゲットにしている場合でも適用されます。たとえば、foo*,bar*をターゲットにするリクエストは、fooで始まるインデックスがあるが、barで始まるインデックスがない場合にエラーを返します。
    デフォルトはtrueです。
  • expand_wildcards
  • （オプション、文字列）ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームをターゲットにできる場合、この引数はワイルドカード式が隠しデータストリームに一致するかどうかを決定します。カンマ区切りの値（open,hiddenなど）をサポートします。有効な値は次のとおりです：
    • all
    • すべてのデータストリームまたはインデックスに一致します。隠し（hidden）のものも含まれます。
    • open
    • オープンで非隠しのインデックスに一致します。また、非隠しのデータストリームにも一致します。
    • closed
    • 閉じた非隠しのインデックスに一致します。また、非隠しのデータストリームにも一致します。データストリームは閉じることができません。
    • hidden
    • 隠しデータストリームと隠しインデックスに一致します。open、closed、またはその両方と組み合わせる必要があります。
    • none
    • ワイルドカードパターンは受け付けられません。
      デフォルトはallです。
  • ignore_unavailable
  • （オプション、ブール値）falseの場合、<target>に欠落したデータストリームまたはインデックスを含むリクエストはエラーを返します。デフォルトはfalseです。
  • local
  • （オプション、ブール値）trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。