エイリアスAPI

1つ以上のエイリアスアクションを単一の原子的操作で実行します。

Python

  1. resp = client.indices.update_aliases(
  2.    actions=[
  3.    {
  4.    "add": {
  5.    "index": "my-data-stream",
  6.    "alias": "my-alias"
  7.    }
  8.    }
  9.    ],
  10. )
  11. print(resp)

Ruby

  1. response = client.indices.update_aliases(
  2.   body: {
  3.    actions: [
  4.    {
  5.    add: {
  6.    index: 'my-data-stream',
  7.    alias: 'my-alias'
  8.    }
  9.    }
  10.    ]
  11.   }
  12. )
  13. puts response

Js

  1. const response = await client.indices.updateAliases({
  2.   actions: [
  3.    {
  4.    add: {
  5.    index: "my-data-stream",
  6.    alias: "my-alias",
  7.    },
  8.    },
  9.   ],
  10. });
  11. console.log(response);

コンソール

  1. POST _aliases
  2. {
  3.   "actions": [
  4.    {
  5.    "add": {
  6.    "index": "my-data-stream",
  7.    "alias": "my-alias"
  8.    }
  9.    }
  10.   ]
  11. }

リクエスト

POST _aliases

前提条件

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

クエリパラメータ

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

リクエストボディ

  • actions
  • (必須、オブジェクトの配列) 実行するアクション。 
    1. -   `````<action>
    • (必須、オブジェクト) キーはアクションタイプです。少なくとも1つのアクションが必要です。
      有効な<action>キー
      • add
      • エイリアスにデータストリームまたはインデックスを追加します。エイリアスが存在しない場合、addアクションがそれを作成します。
      • remove
      • エイリアスからデータストリームまたはインデックスを削除します。
      • remove_index
      • インデックスを削除します。このアクションはエイリアスやデータストリームには使用できません。
        オブジェクトボディにはエイリアスのオプションが含まれています。空のオブジェクトをサポートします。
        <action>のプロパティ
      • alias
      • (必須、文字列) アクションのエイリアス。インデックスエイリアス名は日付数学をサポートします。aliasesが指定されていない場合、addおよびremoveアクションはこのパラメータを必要とします。removeアクションの場合、このパラメータはワイルドカード(`````)をサポートします。remove_index`````アクションはこのパラメータをサポートしていません。
      • aliases
      • (必須、文字列の配列) アクションのエイリアス。インデックスエイリアス名は日付数学をサポートします。aliasが指定されていない場合、addおよびremoveアクションはこのパラメータを必要とします。removeアクションの場合、このパラメータはワイルドカード(`````)をサポートします。remove_index`````アクションはこのパラメータをサポートしていません。
      • filter
      • (オプション、クエリDSLオブジェクト エイリアスがアクセスできるドキュメントを制限するために使用されるクエリ。
        このパラメータをサポートするのはaddアクションのみです。
      • index
      • (必須、文字列) アクションのデータストリームまたはインデックス。ワイルドカード(`````)をサポートします。indicesが指定されていない場合、このパラメータは必須です。addおよびremove_index`````アクションの場合、データストリームとインデックスの両方に一致するワイルドカードパターンはエラーを返します。
      • indices
      • (必須、文字列の配列) アクションのデータストリームまたはインデックス。ワイルドカード(`````)をサポートします。indexが指定されていない場合、このパラメータは必須です。addおよびremove_index`````アクションの場合、データストリームとインデックスの両方に一致するワイルドカードパターンはエラーを返します。
      • index_routing
      • (オプション、文字列) インデックス操作を特定のシャードにルーティングするために使用される値。指定された場合、これはインデックス操作のrouting値を上書きします。データストリームエイリアスはこのパラメータをサポートしていません。
        このパラメータをサポートするのはaddアクションのみです。
      • is_hidden
      • (オプション、Boolean) trueの場合、エイリアスは非表示です。デフォルトはfalseです。エイリアスのすべてのデータストリームまたはインデックスは同じis_hidden値を持っている必要があります。
        このパラメータをサポートするのはaddアクションのみです。
      • is_write_index
      • (オプション、Boolean) trueの場合、エイリアスの書き込みインデックスまたはデータストリームを設定します。
        エイリアスが複数のインデックスまたはデータストリームを指している場合、is_write_indexが設定されていないと、エイリアスは書き込みリクエストを拒否します。インデックスエイリアスが1つのインデックスを指している場合、is_write_indexが設定されていないと、そのインデックスは自動的に書き込みインデックスとして機能します。データストリームエイリアスは、たとえエイリアスが1つのデータストリームを指していても、自動的に書き込みデータストリームを設定しません。
        このパラメータをサポートするのはaddアクションのみです。
      • must_exist
      • (オプション、Boolean) 存在しないエイリアスを削除しようとしたときの動作に影響します。trueの場合、存在しないエイリアスを削除すると、すべてのアクションが失敗します。falseの場合、存在しないエイリアスを削除すると、その削除のみが失敗します。デフォルトはfalseです。
        このパラメータをサポートするのはremoveアクションのみです。
      • routing
      • (オプション、文字列) インデックスおよび検索操作を特定のシャードにルーティングするために使用される値。データストリームエイリアスはこのパラメータをサポートしていません。
        このパラメータをサポートするのはaddアクションのみです。
      • search_routing
      • (オプション、文字列) 検索操作を特定のシャードにルーティングするために使用される値。指定された場合、これは検索操作のrouting値を上書きします。データストリームエイリアスはこのパラメータをサポートしていません。
        このパラメータをサポートするのはaddアクションのみです。

レスポンスボディ

  • acknowledged
  • (Boolean) trueの場合、リクエストはtimeout期間内にマスターノードからの応答を受け取りました。
  • errors
  • (Boolean) trueの場合、要求されたアクションのうち少なくとも1つが失敗しました。
  • action_results
  • (オプション、オブジェクトの配列) 要求された各アクションの結果。 
    1. -   `````action
    • (オブジェクト) 関連するアクションリクエストの説明。 
      1. -   `````type
      • (文字列) 関連するアクションのタイプ、add、remove、またはremove_indexのいずれか。
      • indices
      • (文字列の配列) 関連するアクションのインデックスのリスト。
      • aliases
      • (文字列の配列) 関連するアクションのエイリアスのリスト。
    • status
    • (整数) アクションに対して返されたHTTPステータスコード。
    • error
    • (オプション、オブジェクト) 失敗したアクションに関する追加情報を含みます。
      アクションが失敗した場合のみ存在します。