インデックスライフサイクル管理ステータスAPI

現在のindex lifecycle management (ILM) ステータスを取得します。

start ILM および stop ILM APIを使用してILMを開始または停止できます。

リクエスト

GET /_ilm/status

前提条件

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

クエリパラメータ

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

レスポンスボディ

  • operation_mode
  • （文字列）ILMの現在の操作モード。 
    1. -   `````RUNNING
    • ILMが実行中です。
    • STOPPING
    • ILMが進行中のshrinkなどの重要なアクションを完了しています。これらのアクションが完了すると、ILMはSTOPPEDに移行します。
    • STOPPED
    • ILMは実行されていません。

例

次の例はILMプラグインのステータスを取得します。

Python

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

Ruby

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

Js

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

コンソール

  1. GET _ilm/status

リクエストが成功した場合、レスポンスのボディには操作モードが表示されます:

コンソール-結果

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