Get the pending cluster tasks

  • GET /_cluster/pending_tasks
Auth

Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

Note

This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

Required authorization

Cluster privileges monitor

Query parameters

local boolean · default: false

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

master_timeout string · default: 30s

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Response

application/json
tasks object[] required
executing boolean required

Indicates whether the pending tasks are currently executing or not.

insert_order number required

The number that represents when the task has been inserted into the task queue.

priority string required

The priority of the pending task. The valid priorities in descending priority order are: IMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUID.

source string required

A general description of the cluster task that may include a reason and origin.

time_in_queue string

The time since the task is waiting for being performed.

time_in_queue_millis number required

The time expressed in milliseconds since the task is waiting for being performed.