ポリシーを削除（Delete policy）

ライフサイクルポリシー削除API

インデックス ライフサイクル ポリシーを削除します。

リクエスト

DELETE _ilm/policy/<policy_id>

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmanage_ilmクラスター権限が必要です。詳細については、セキュリティ権限を参照してください。

説明

指定されたライフサイクルポリシー定義を削除します。現在使用中のポリシーは削除できません。ポリシーがインデックスの管理に使用されている場合、リクエストは失敗し、エラーが返されます。

パスパラメータ

• <policy_id>
• （必須、文字列）ポリシーの識別子。

クエリパラメータ

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

例

次の例はmy_policyを削除します:

Python

resp = client.ilm.delete_lifecycle(
   name="my_policy",
)
print(resp)

Ruby

response = client.ilm.delete_lifecycle(
  policy: 'my_policy'
)
puts response

Js

const response = await client.ilm.deleteLifecycle({
  name: "my_policy",
});
console.log(response);

コンソール

DELETE _ilm/policy/my_policy

ポリシーが正常に削除されると、次の結果が返されます:

コンソール-結果

{
  "acknowledged": true
}