エイリアス削除API
データストリームまたはインデックスをエイリアスから削除します。
Python
resp = client.indices.delete_alias(
index="my-data-stream",
name="my-alias",
)
print(resp)
Ruby
response = client.indices.delete_alias(
index: 'my-data-stream',
name: 'my-alias'
)
puts response
Js
const response = await client.indices.deleteAlias({
index: "my-data-stream",
name: "my-alias",
});
console.log(response);
コンソール
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
に設定することもできます。