Get all tasks

GET /_tasks

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.

Required authorization

Cluster privileges: monitor

Query Parameters

Response

application/json

Examples

A successful response from GET _tasks?actions=*search&detailed The detailed parameter affects the description field, which contains human readable text that identifies the particular request that the task is performing. For example, it helps identify the search request being performed by a search task.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _tasks?actions=*search&detailed

JavaScript Elasticsearch JavaScript Client

const response = await client.tasks.list({
  actions: "*search",
  detailed: "true",
});

Python Elasticsearch Python Client

resp = client.tasks.list(
    actions="*search",
    detailed=True,
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_tasks?actions=*search&detailed" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

C# Elasticsearch .NET Client

var response = await client.Tasks
    .ListAsync(d1 => d1
        .Actions("*search")
        .Detailed(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->tasks()->list([
    "actions" => "*search",
    "detailed" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.tasks.list(
  actions: "*search",
  detailed: "true"
)

Response

{
  "nodes" : {
    "oTUltX4IQMOUUVeiohTt8A" : {
      "name" : "H5dfFeA",
      "transport_address" : "127.0.0.1:9300",
      "host" : "127.0.0.1",
      "ip" : "127.0.0.1:9300",
      "tasks" : {
        "oTUltX4IQMOUUVeiohTt8A:464" : {
          "node" : "oTUltX4IQMOUUVeiohTt8A",
          "id" : 464,
          "type" : "transport",
          "action" : "indices:data/read/search",
          "description" : "indices[test], types[test], search_type[QUERY_THEN_FETCH], source[{\"query\":...}]",
          "start_time_in_millis" : 1483478610008,
          "running_time_in_nanos" : 13991383,
          "cancellable" : true,
          "cancelled" : false
        }
      }
    }
  }
}

Required authorization

Query Parameters { actions , detailed , group_by , nodes , parent_task_id , timeout , wait_for_completion , }

Response

Query Parameters