Alice Williams
fe8d702ca9
* add operation to titles to differentiate from the API group acronym Signed-off-by: alicejw <[email protected]> * update frontmatter with new page title Signed-off-by: alicejw <[email protected]> * for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713 Signed-off-by: alicejw <[email protected]> * to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly Signed-off-by: alicejw <[email protected]> * to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title Signed-off-by: alicejw <[email protected]> Signed-off-by: alicejw <[email protected]>
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
---
|
|
layout: default
|
|
title: CAT tasks
|
|
parent: CAT API
|
|
|
|
nav_order: 70
|
|
has_children: false
|
|
---
|
|
|
|
# CAT tasks
|
|
Introduced 1.0
|
|
{: .label .label-purple }
|
|
|
|
The CAT tasks operation lists the progress of all tasks currently running on your cluster.
|
|
|
|
## Example
|
|
|
|
```
|
|
GET _cat/tasks?v
|
|
```
|
|
|
|
## Path and HTTP methods
|
|
|
|
```
|
|
GET _cat/tasks
|
|
```
|
|
|
|
## URL parameters
|
|
|
|
All CAT tasks URL parameters are optional.
|
|
|
|
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
|
|
|
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
|
|
```
|