2021-06-22 02:13:40 -04:00
|
|
|
---
|
|
|
|
layout: default
|
2022-10-31 12:21:32 -04:00
|
|
|
title: CAT thread pool
|
|
|
|
parent: CAT API
|
2021-06-22 02:13:40 -04:00
|
|
|
nav_order: 75
|
|
|
|
has_children: false
|
2023-05-04 14:22:52 -04:00
|
|
|
redirect_from:
|
|
|
|
- /opensearch/rest-api/cat/cat-thread-pool/
|
2021-06-22 02:13:40 -04:00
|
|
|
---
|
|
|
|
|
2022-10-31 12:21:32 -04:00
|
|
|
# CAT thread pool
|
2023-10-23 10:53:52 -04:00
|
|
|
**Introduced 1.0**
|
2021-07-26 19:14:22 -04:00
|
|
|
{: .label .label-purple }
|
2021-06-22 02:13:40 -04:00
|
|
|
|
2022-10-31 12:21:32 -04:00
|
|
|
The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
|
2021-06-22 02:13:40 -04:00
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
```
|
|
|
|
GET _cat/thread_pool?v
|
|
|
|
```
|
2023-01-30 17:09:38 -05:00
|
|
|
{% include copy-curl.html %}
|
2021-06-22 02:13:40 -04:00
|
|
|
|
|
|
|
If you want to get information for more than one thread pool, separate the thread pool names with commas:
|
|
|
|
|
|
|
|
```
|
2022-12-13 12:52:53 -05:00
|
|
|
GET _cat/thread_pool/thread_pool_name_1,thread_pool_name_2,thread_pool_name_3
|
|
|
|
```
|
2023-01-30 17:09:38 -05:00
|
|
|
{% include copy-curl.html %}
|
2022-12-13 12:52:53 -05:00
|
|
|
|
|
|
|
If you want to limit the information to a specific thread pool, add the thread pool name after your query:
|
|
|
|
|
|
|
|
```
|
|
|
|
GET _cat/thread_pool/<thread_pool_name>?v
|
2021-06-22 02:13:40 -04:00
|
|
|
```
|
2023-01-30 17:09:38 -05:00
|
|
|
{% include copy-curl.html %}
|
2021-06-22 02:13:40 -04:00
|
|
|
|
|
|
|
## Path and HTTP methods
|
|
|
|
|
|
|
|
```
|
|
|
|
GET _cat/thread_pool
|
|
|
|
```
|
|
|
|
|
|
|
|
## URL parameters
|
|
|
|
|
2022-10-31 12:21:32 -04:00
|
|
|
All CAT thread pool URL parameters are optional.
|
2021-06-22 02:13:40 -04:00
|
|
|
|
2023-05-04 14:22:52 -04:00
|
|
|
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
2021-06-22 02:13:40 -04:00
|
|
|
|
|
|
|
Parameter | Type | Description
|
|
|
|
:--- | :--- | :---
|
2022-12-06 16:52:33 -05:00
|
|
|
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.
|
2021-06-22 02:13:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
## Response
|
|
|
|
|
|
|
|
```json
|
|
|
|
node_name name active queue rejected
|
|
|
|
odfe-node2 ad-batch-task-threadpool 0 0 0
|
|
|
|
odfe-node2 ad-threadpool 0 0 0
|
2021-07-26 19:14:22 -04:00
|
|
|
odfe-node2 analyze 0 0 0s
|
2021-06-22 02:13:40 -04:00
|
|
|
```
|