Files
OpenSearch-Docs-Cn/_api-reference/cat/cat-tasks.md
T

51 lines
1.6 KiB
Markdown
Raw Normal View History

2021-06-21 23:13:40 -07:00
---
layout: default
title: CAT tasks
parent: CAT API
2022-10-27 11:50:39 -05:00
2021-06-21 23:13:40 -07:00
nav_order: 70
has_children: false
2023-05-04 11:22:52 -07:00
redirect_from:
- /opensearch/rest-api/cat/cat-tasks/
2021-06-21 23:13:40 -07:00
---
# CAT tasks
**Introduced 1.0**
2021-07-26 16:14:22 -07:00
{: .label .label-purple }
2021-06-21 23:13:40 -07:00
The CAT tasks operation lists the progress of all tasks currently running on your cluster.
2021-06-21 23:13:40 -07:00
## Example
```
GET _cat/tasks?v
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
## Path and HTTP methods
```
GET _cat/tasks
```
## URL parameters
All CAT tasks URL parameters are optional.
2021-06-21 23:13:40 -07:00
2023-05-04 11:22:52 -07:00
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
2021-06-21 23:13:40 -07:00
Parameter | Type | Description
:--- | :--- | :---
nodes | List | A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
detailed | Boolean | Returns detailed task information. (Default: false)
parent_task_id | String | Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
## Response
```json
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
```