エイリアスの作成または更新 API

データストリームまたはインデックスをエイリアスに追加します。

Python

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

Ruby

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

Js

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

コンソール

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

リクエスト

POST <target>/_alias/<alias>

POST <target>/_aliases/<alias>

PUT <target>/_alias/<alias>

PUT <target>/_aliases/<alias>

前提条件

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

パスパラメータ

  • <alias>
  • (必須、文字列) 更新するエイリアス。エイリアスが存在しない場合、リクエストはそれを作成します。インデックスエイリアス名は日付数学をサポートします。
  • <target>
  • (必須、文字列) 追加するデータストリームまたはインデックスのカンマ区切りリスト。ワイルドカード(*)をサポートします。データストリームとインデックスの両方に一致するワイルドカードパターンはエラーを返します。

クエリパラメータ

  • master_timeout
  • (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • timeout
  • (オプション、時間単位) クラスタメタデータを更新した後、クラスタ内のすべての関連ノードからの応答を待機する期間。タイムアウトが切れる前に応答が受信されない場合、クラスタメタデータの更新は適用されますが、応答は完全に承認されなかったことを示します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

リクエストボディ

  • filter
  • (オプション、クエリ DSL オブジェクト エイリアスがアクセスできるドキュメントを制限するために使用されるクエリ。
  • index_routing
  • (オプション、文字列) インデックス操作を特定のシャードにルーティングするために使用される値。指定された場合、これはインデックス操作のrouting値を上書きします。データストリームエイリアスはこのパラメータをサポートしていません。
  • is_hidden
  • (オプション、ブール値) trueの場合、エイリアスは非表示になります。デフォルトはfalseです。エイリアスのすべてのデータストリームまたはインデックスは同じis_hidden値を持っている必要があります。
  • is_write_index
  • (オプション、ブール値) trueの場合、エイリアスの書き込みインデックスまたはデータストリームを設定します。
    エイリアスが複数のインデックスまたはデータストリームを指していて、is_write_indexが設定されていない場合、エイリアスは書き込みリクエストを拒否します。インデックスエイリアスが1つのインデックスを指していて、is_write_indexが設定されていない場合、そのインデックスは自動的に書き込みインデックスとして機能します。データストリームエイリアスは、たとえエイリアスが1つのデータストリームを指していても、自動的に書き込みデータストリームを設定しません。
  • must_exist
  • (オプション、ブール値) 存在しないエイリアスを削除しようとしたときの動作に影響します。trueの場合、存在しないエイリアスを削除すると、すべてのアクションが失敗します。falseの場合、存在しないエイリアスを削除すると、その削除のみが失敗します。デフォルトはfalseです。
  • routing
  • (オプション、文字列) インデックスおよび検索操作を特定のシャードにルーティングするために使用される値。データストリームエイリアスはこのパラメータをサポートしていません。
  • search_routing
  • (オプション、文字列) 検索操作を特定のシャードにルーティングするために使用される値。指定された場合、これは検索操作のrouting値を上書きします。データストリームエイリアスはこのパラメータをサポートしていません。