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

53 lines
1.3 KiB
Markdown

---
layout: default
title: CAT thread pool
parent: CAT API
nav_order: 75
has_children: false
---
# CAT thread pool
Introduced 1.0
{: .label .label-purple }
The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
## Example
```
GET _cat/thread_pool?v
```
If you want to get information for more than one thread pool, separate the thread pool names with commas:
```
GET _cat/v/thread_pool_name_1,thread_pool_name_2,thread_pool_name_3
```
## Path and HTTP methods
```
GET _cat/thread_pool
```
## URL parameters
All CAT thread pool 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
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
## Response
```json
node_name name active queue rejected
odfe-node2 ad-batch-task-threadpool 0 0 0
odfe-node2 ad-threadpool 0 0 0
odfe-node2 analyze 0 0 0s
```