Get all tasks Technical preview
Get information about the tasks currently running on one or more nodes in the cluster.
WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.
Identifying running tasks
The X-Opaque-Id header
, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.
This enables you to track certain calls or associate certain tasks with the client that started them.
For example:
curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"
The API returns the following result:
HTTP/1.1 200 OK
X-Opaque-Id: 123456
content-type: application/json; charset=UTF-8
content-length: 831
{
"tasks" : {
"u5lcZHqcQhu-rUoFaqDphA:45" : {
"node" : "u5lcZHqcQhu-rUoFaqDphA",
"id" : 45,
"type" : "transport",
"action" : "cluster:monitor/tasks/lists",
"start_time_in_millis" : 1513823752749,
"running_time_in_nanos" : 293139,
"cancellable" : false,
"headers" : {
"X-Opaque-Id" : "123456"
},
"children" : [
{
"node" : "u5lcZHqcQhu-rUoFaqDphA",
"id" : 46,
"type" : "direct",
"action" : "cluster:monitor/tasks/lists[n]",
"start_time_in_millis" : 1513823752750,
"running_time_in_nanos" : 92133,
"cancellable" : false,
"parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45",
"headers" : {
"X-Opaque-Id" : "123456"
}
}
]
}
}
}
In this example, X-Opaque-Id: 123456
is the ID as a part of the response header.
The X-Opaque-Id
in the task headers
is the ID for the task that was initiated by the REST request.
The X-Opaque-Id
in the children headers
is the child task of the task that was initiated by the REST request.
Query parameters
-
actions string | array[string]
A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use
cluser:*
to retrieve all cluster-related tasks. -
detailed boolean
If
true
, the response includes detailed information about the running tasks. This information is useful to distinguish tasks from each other but is more costly to run. -
group_by string
A key that is used to group tasks in the response. The task lists can be grouped either by nodes or by parent tasks.
Values are
nodes
,parents
, ornone
. -
nodes string | array[string]
A comma-separated list of node IDs or names that is used to limit the returned information.
-
parent_task_id string
A parent task identifier that is used to limit returned information. To return all tasks, omit this parameter or use a value of
-1
. If the parent task is not found, the API does not return a 404 response code. -
master_timeout string
The 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.
-
timeout string
The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the
node_failures
property. -
wait_for_completion boolean
If
true
, the request blocks until the operation is complete.
curl \
-X GET http://api.example.com/_tasks
{
"nodes" : {
"oTUltX4IQMOUUVeiohTt8A" : {
"name" : "H5dfFeA",
"transport_address" : "127.0.0.1:9300",
"host" : "127.0.0.1",
"ip" : "127.0.0.1:9300",
"tasks" : {
"oTUltX4IQMOUUVeiohTt8A:124" : {
"node" : "oTUltX4IQMOUUVeiohTt8A",
"id" : 124,
"type" : "direct",
"action" : "cluster:monitor/tasks/lists[n]",
"start_time_in_millis" : 1458585884904,
"running_time_in_nanos" : 47402,
"cancellable" : false,
"parent_task_id" : "oTUltX4IQMOUUVeiohTt8A:123"
},
"oTUltX4IQMOUUVeiohTt8A:123" : {
"node" : "oTUltX4IQMOUUVeiohTt8A",
"id" : 123,
"type" : "transport",
"action" : "cluster:monitor/tasks/lists",
"start_time_in_millis" : 1458585884904,
"running_time_in_nanos" : 236042,
"cancellable" : false
}
}
}
}
}