› › ›

API cat thread pool

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

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

Запрос

GET /_cat/thread_pool/<thread_pool>

GET /_cat/thread_pool

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

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

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

<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: Настроенное ядро (core) активных потоков, разрешённых в текущем пуле потоков.
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. Также может быть установлено на -1, чтобы указать, что запрос никогда не должен ожидать.

s

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

time

(Необязательно, единицы времени) Единица измерения времени значений.

v

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

Примеры

Пример с колонками по умолчанию

resp = client.cat.thread_pool()
print(resp)

response = client.cat.thread_pool
puts response

const response = await client.cat.threadPool();
console.log(response);

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.

resp = client.cat.thread_pool(
    thread_pool_patterns="generic",
    v=True,
    h="id,name,active,rejected,completed",
)
print(resp)

response = client.cat.thread_pool(
  thread_pool_patterns: 'generic',
  v: true,
  h: 'id,name,active,rejected,completed'
)
puts response

const response = await client.cat.threadPool({
  thread_pool_patterns: "generic",
  v: "true",
  h: "id,name,active,rejected,completed",
});
console.log(response);

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/8.17/cat-thread-pool.html