スナップショットライフサイクル管理APIの停止

スナップショットライフサイクル管理（SLM）をオフにします。

リクエスト

POST /_slm/stop

前提条件

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

説明

すべてのスナップショットライフサイクル管理（SLM）操作を停止し、SLMプラグインを停止します。これは、クラスターのメンテナンスを行っているときに、SLMがデータストリームやインデックスに対して何らかのアクションを実行するのを防ぐために便利です。SLMを停止しても、進行中のスナップショットは停止しません。SLMが停止していても、スナップショットライフサイクルポリシーの実行を使用して手動でスナップショットをトリガーできます。

APIはリクエストが承認されるとすぐに応答を返しますが、プラグインは進行中の操作が完了するまで実行を続け、安全に停止できるまで待機する場合があります。

SLMが実行中かどうかを確認するには、スナップショットライフサイクル管理のステータスを取得を使用してください。

クエリパラメータ

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

例

Python

  1. resp = client.slm.stop()
  2. print(resp)

Js

  1. const response = await client.slm.stop();
  2. console.log(response);

コンソール

  1. POST _slm/stop