保留中のクラスタータスク（Pending cluster tasks）

保留クラスタータスクAPI

実行されていないクラスターレベルの変更を返します。

リクエスト

GET /_cluster/pending_tasks

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

説明

保留中のクラスタータスクAPIは、まだ実行されていないクラスターレベルの変更（例：インデックスの作成、マッピングの更新、シャードの割り当てまたは失敗）をリストとして返します。

このAPIは、クラスター状態に対する保留中の更新のリストを返します。これらは、タスク管理APIによって報告されるタスクとは異なり、定期的なタスクやユーザーによって開始されたタスク（ノードの統計、検索クエリ、インデックス作成リクエストなど）が含まれます。ただし、インデックス作成コマンドなどのユーザーによって開始されたタスクがクラスター状態の更新を引き起こす場合、このタスクのアクティビティはタスクAPIと保留中のクラスタータスクAPIの両方によって報告される可能性があります。

パスパラメータ

• local
• (オプション、ブール値) trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
• master_timeout
• (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは30sです。リクエストが決してタイムアウトしないことを示すために-1に設定することもできます。

レスポンスボディ

• tasks
• (オブジェクト) 保留中のタスクのリスト。
• insert_order
• (整数) タスクがタスクキューに挿入されたときの番号。
• priority
• (文字列) 保留中のタスクの優先度。優先度の有効な順序は、降順でIMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUIDです。
• source
• (文字列) 理由や起源を含む可能性のあるクラスタータスクの一般的な説明。
• executing
• (ブール値) 保留中のタスクが現在実行中かどうかを示す真または偽。
• time_in_queue_millis
• (整数) タスクが実行されるのを待っている間のミリ秒で表現された時間。
• time_in_queue
• (文字列) タスクが実行されるのを待っている間の時間。

例

通常、リクエストはクラスターレベルの変更が迅速であるため、空のリストを返します。ただし、タスクがキューに入っている場合、レスポンスは次のようになります:

Js

{
   "tasks": [
   {
   "insert_order": 101,
   "priority": "URGENT",
   "source": "create-index [foo_9], cause [api]",
   "executing" : true,
   "time_in_queue_millis": 86,
   "time_in_queue": "86ms"
   },
   {
   "insert_order": 46,
   "priority": "HIGH",
   "source": "shard-started ([foo_2][1], node[tMTocMvQQgGCkj7QDHl3OA], [P], s[INITIALIZING]), reason [after recovery from shard_store]",
   "executing" : false,
   "time_in_queue_millis": 842,
   "time_in_queue": "842ms"
   },
   {
   "insert_order": 45,
   "priority": "HIGH",
   "source": "shard-started ([foo_2][0], node[tMTocMvQQgGCkj7QDHl3OA], [P], s[INITIALIZING]), reason [after recovery from shard_store]",
   "executing" : false,
   "time_in_queue_millis": 858,
   "time_in_queue": "858ms"
   }
  ]
}