インデックスライフサイクル管理API - インデックスライフサイクル管理を停止（Stop index lifecycle management）

インデックスライフサイクル管理APIの停止

POST /_ilm/stop

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

すべてのライフサイクル管理操作を停止し、ILMプラグインを停止します。これは、クラスタのメンテナンスを行っているときに、ILMがインデックスに対して何らかのアクションを実行するのを防ぐために便利です。

APIは、停止リクエストが承認されるとすぐに返されますが、プラグインは進行中の操作が完了するまで実行を続ける可能性があり、プラグインを安全に停止できる状態になるまで待機します。ILMステータスの取得 APIを使用して、ILMが実行中かどうかを確認します。

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

以下の例は、ILMプラグインを停止します。

resp = client.ilm.stop()
print(resp)

response = client.ilm.stop
puts response

const response = await client.ilm.stop();
console.log(response);

POST _ilm/stop

リクエストにエラーが発生しない場合、次の結果が返されます:

{
  "acknowledged": true
}