スナップショットライフサイクル管理ステータスAPI

スナップショットライフサイクル管理（SLM）のステータスを取得します。

リクエスト

GET /_slm/status

説明

SLMプラグインのステータスを返します。レスポンスのoperation_modeフィールドは、RUNNING、STOPPING、またはSTOPPEDのいずれかの3つの状態の1つを示します。stopおよびstart APIを使用して、SLMプラグインを停止および再起動します。

クエリパラメータ

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

前提条件

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

例

Python

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

Ruby

  1. response = client.slm.get_status
  2. puts response

Js

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

コンソール

  1. GET _slm/status

APIは次の結果を返します:

コンソール-結果

  1. {
  2.   "operation_mode": "RUNNING"
  3. }