Get task information Technical preview
Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
Query parameters
-
actions array[string]
The task action names, which are used to limit the response.
-
detailed boolean
If
true
, the response includes detailed information about shard recoveries. -
nodes array[string]
Unique node identifiers, which are used to limit the response.
-
parent_task_id string
The parent task identifier, which is used to limit the response.
-
time string
Unit used to display time values.
Values are
nanos
,micros
,ms
,s
,m
,h
, ord
. -
timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
-
wait_for_completion boolean
If
true
, the request blocks until the task has completed.
curl \
-X GET http://api.example.com/_cat/tasks
[
{
"id": "string",
"action": "string",
"task_id": "string",
"parent_task_id": "string",
"type": "string",
"start_time": "string",
"timestamp": "string",
"running_time_ns": "string",
"running_time": "string",
"node_id": "string",
"ip": "string",
"port": "string",
"node": "string",
"version": "string",
"x_opaque_id": "string",
"description": "string"
}
]