You're viewing version 2.18 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
CAT tasks
Introduced 1.0
The CAT tasks operation lists the progress of all tasks currently running on your cluster.
Endpoints
GET /_cat/tasks
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
actions | List | The task action names used to limit the response. | N/A |
detailed | Boolean | If true, the response includes detailed information about shard recoveries. | false |
format | String | A short version of the Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
nodes | List | A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node to which you’re connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. | N/A |
parent_task_id | String | The parent task identifier, which is used to limit the response. | N/A |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
time | String | Specifies the time units, for example, 5d or 7h. For more information, see Supported units. Valid values are: nanos, micros, ms, s, m, h, d | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
Example request
The following example request lists all tasks in progress:
GET _cat/tasks?v
Example response
action | task_id | parent_task_id | type | start_time | timestamp | running_time | ip | node
cluster:monitor/tasks/lists | 1vo54NuxSxOrbPEYdkSF0w:168062 | - | transport | 1624337809471 | 04:56:49 | 489.5ms | 172.18.0.4 | odfe-node1