エイリアス削除API

データストリームまたはインデックスをエイリアスから削除します。

Python

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

Ruby

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

Js

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

コンソール

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

リクエスト

DELETE <target>/_alias/<alias>

DELETE <target>/_aliases/<alias>

前提条件

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

パスパラメータ

  • <alias>
  • (必須、文字列) 削除するエイリアスのカンマ区切りリスト。ワイルドカード(*)をサポートします。すべてのエイリアスを削除するには、*または_allを使用します。
  • <target>
  • (必須、文字列) リクエストを制限するために使用されるデータストリームまたはインデックスのカンマ区切りリスト。ワイルドカード(*)をサポートします。

クエリパラメータ

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