cat task management API
editcat task management API
editThe cat task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. For feature status, see #51628.
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.
Returns information about tasks currently executing in the cluster, similar to the task management API.
Request
editGET /_cat/tasks
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor
ormanage
cluster privilege to use this API.
Description
editThe cat task management API returns information about tasks currently executing on one or more nodes in the cluster. It is a more compact view of the JSON task management API.
Query parameters
edit-
detailed
-
(Optional, Boolean)
If
true
, the response includes detailed information about shard recoveries. Defaults tofalse
. -
format
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h
- (Optional, string) Comma-separated list of column names to display.
-
help
-
(Optional, Boolean) If
true
, the response includes help information. Defaults tofalse
. -
nodes
-
(Optional, string)
Comma-separated list of node IDs or names used to limit the response. Supports
wildcard (
*
) expressions. -
parent_task_id
- (Optional, string) Parent task ID used to limit the response.
-
s
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
time
- (Optional, time units) Unit used to display time values.
-
v
-
(Optional, Boolean) If
true
, the response includes column headings. Defaults tofalse
.
Response codes
edit-
404
(Missing resources) -
If
<task_id>
is specified but not found, this code indicates that there are no resources that match the request.
Examples
editresp = client.cat.tasks( v=True, ) print(resp)
response = client.cat.tasks( v: true ) puts response
const response = await client.cat.tasks({ v: "true", }); console.log(response);
GET _cat/tasks?v=true
The API returns the following response:
action task_id parent_task_id type start_time timestamp running_time ip node cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A cluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A