opensearch-docs-cn/_api-reference/cat/cat-pending-tasks.md
Alice Williams fe8d702ca9
add operation to titles to differentiate from the API group acronym (#1750)
* add operation to titles to differentiate from the API group acronym

Signed-off-by: alicejw <alicejw@amazon.com>

* update frontmatter with new page title

Signed-off-by: alicejw <alicejw@amazon.com>

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

Signed-off-by: alicejw <alicejw@amazon.com>

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

Signed-off-by: alicejw <alicejw@amazon.com>

* 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 <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-31 09:21:32 -07:00

1.2 KiB

layout title parent nav_order has_children
default CAT pending tasks CAT API 45 false

CAT pending tasks

Introduced 1.0 {: .label .label-purple }

The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.

Example

GET _cat/pending_tasks?v

Path and HTTP methods

GET _cat/pending_tasks

URL parameters

All CAT nodes URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

Parameter Type Description
local Boolean Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout Time The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
time Time Specify the units for time. For example, 5d or 7h. For more information, see Supported units.

Response

insertOrder | timeInQueue | priority | source
  1786      |    1.8s     |  URGENT  | shard-started