› › ›

API cat thread pool

API cat предназначены только для использования человеком с помощью командной строки или консоли Kibana. Они не предназначены для использования приложениями. Для использования приложением используйте API информации о узлах.

Возвращает статистику пула потоков для каждого узла в кластере. Возвращаемая информация включает все встроенные пулы потоков и пользовательские пулы потоков.

Запрос

GET /_cat/thread_pool/<thread_pool>

GET /_cat/thread_pool

Предварительные условия

Если функции безопасности Elasticsearch включены, для использования этого API вам необходим monitor или manage доступ к кластеру.

Параметры пути

<thread_pool>: (Необязательно, строка) Список имён пулов потоков, разделённых запятыми, используемых для ограничения запроса. Поддерживаются выражения с подстановкой.

Параметры запроса

format

(Необязательно, строка) Короткая версия заголовка HTTP accept. Допустимые значения: JSON, YAML и т. д.

h

(Необязательно, строка) Список имён столбцов, разделённых запятыми, для отображения.

Если вы не укажете, какие столбцы включать, API возвратит стандартные столбцы в указанном ниже порядке. Если вы явно укажете один или несколько столбцов, будут возвращены только указанные столбцы.

Допустимые столбцы:

node_name: (По умолчанию) Имя узла, например I8hydUG.
name: (По умолчанию) Имя пула потоков, например analyze или generic.
active, a: (По умолчанию) Количество активных потоков в текущем пуле потоков.
queue,q: (По умолчанию) Количество задач в очереди для текущего пула потоков.
rejected, r: (По умолчанию) Количество задач, отклоненных исполнителем пула потоков.
completed, c: Количество задач, завершённых исполнителем пула потоков.
core, cr: Настроенное ядро активных потоков, разрешенных в текущем пуле потоков.
ephemeral_id,eid: Идентификатор временного узла.
host, h: Имя хоста текущего узла.
ip, i: IP-адрес текущего узла.
keep_alive, k: Настроенное время ожидания для потоков.
largest, l: Максимальное количество активных потоков в текущем пуле потоков.
max, mx: Настроенное максимальное количество активных потоков, разрешенных в текущем пуле потоков.
node_id, id: Идентификатор узла, например k0zy.
pid, p: Идентификатор процесса работающего узла.
pool_size, psz: Количество потоков в текущем пуле потоков.
port, po: Порт транспорта для текущего узла.
queue_size, qs: Максимальное количество задач, разрешенных в очереди для текущего пула потоков.
size, sz: Настроенное фиксированное количество активных потоков, разрешенных в текущем пуле потоков.
type, t: Тип пула потоков. Возвращаемые значения: fixed, fixed_auto_queue_size, direct или scaling.

help

(Необязательно, логическое значение) Если true, ответ включает справочную информацию. По умолчанию false.

local

(Необязательно, логическое значение) Если true, запрос получает информацию только с локального узла. По умолчанию false, что означает, что информация извлекается с узла-мастера.

master_timeout

(Необязательно, единицы времени) Время ожидания подключения к узлу-мастеру. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.

s

(Необязательно, строка) Список имён столбцов или псевдонимов столбцов, используемых для сортировки ответа.

size

(Необязательно, единицы размера) Множитель, используемый для отображения значений.

v

(Необязательно, логическое значение) Если true, ответ включает заголовки столбцов. По умолчанию false.

Примеры

Пример со стандартными столбцами

GET /_cat/thread_pool

API возвращает следующий ответ:

node-0 analyze             0 0 0
...
node-0 fetch_shard_started 0 0 0
node-0 fetch_shard_store   0 0 0
node-0 flush               0 0 0
...
node-0 write               0 0 0

Пример со явными столбцами

Следующий API-запрос возвращает столбцы id, name, active, rejected и completed. Запрос ограничивает возвращаемую информацию пулом потоков generic.

GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed

API возвращает следующий ответ:

id                     name    active rejected completed
0EWUhXeBQtaVGlexUeVwMg generic      0        0        70

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cat-thread-pool.html