› › ›

API cat nodes

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

Возвращает информацию о узлах кластера.

Запрос

GET /_cat/nodes

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

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

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

bytes

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

format

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

full_id

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

h

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

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

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

ip, i

(Default) IP-адрес, например 127.0.1.1.

heap.percent, hp, heapPercent

(Default) Максимальный объём кучи, например 7.

ram.percent, rp, ramPercent

(Default) Процент используемой общей памяти, например 47.

file_desc.percent, fdp, fileDescriptorPercent

(Default) Процент используемых дескрипторов файлов, например 1.

node.role, r, role, nodeRole

(Default) Роли узла. Возвращаемые значения включают c (холодный узел), d (узел данных), f (замороженный узел), h (горячий узел), i (узел поступления данных), l (узел машинного обучения), m (узел, подходящий для мастера), r (узел-клиент удалённого кластера), s (узел контента), t (узел преобразования), v (узел только для голосования), w (тёплый узел) и - (только координирующий узел).

Например, dim указывает на узел данных и узел поступления данных, подходящий для мастера. См. Узел.

master, m

(Default) Указывает, является ли узел избранным узлом-мастером. Возвращаемые значения включают * (избранный мастер) и - (не избранный мастер).

name, n

(Default) Имя узла, например I8hydUG.

id, nodeId

Идентификатор узла, например k0zy.

pid, p

Идентификатор процесса, например 13061.

port, po

Порт привязки транспорта, например 9300.

http_address, http

Привязанный адрес http, например 127.0.0.1:9200.

version, v

Версия Elasticsearch, например 7.17.28.

build, b

Хеш сборки Elasticsearch, например 5c03844.

jdk, j

Версия Java, например 1.8.0.

disk.total, dt, diskTotal

Общий объём дискового пространства, например 458.3gb.

disk.used, du, diskUsed

Используемое дисковое пространство, например 259.8gb.

disk.avail, d, disk, diskAvail

Доступное дисковое пространство, например 198.4gb.

disk.used_percent, dup, diskUsedPercent

Процент используемого дискового пространства, например 47.

heap.current, hc, heapCurrent

Используемая куча, например 311.2mb.

ram.current,rc, ramCurrent

Используемая общая память, например 513.4mb.

ram.max, rm, ramMax

Общий объём памяти, например 2.9gb.

file_desc.current, fdc, fileDescriptorCurrent

Используемые дескрипторы файлов, например 123.

file_desc.max, fdm, fileDescriptorMax

Максимальное количество дескрипторов файлов, например 1024.

cpu

Недавнее использование процессора системы в процентах, например 12.

load_1m, l

Последнее значение среднего уровня нагрузки, например 0.22.

load_5m, l

Средний уровень нагрузки за последние пять минут, например 0.78.

load_15m, l

Средний уровень нагрузки за последние пятнадцать минут, например 1.24.

uptime, u

Время работы узла, например 17.3m.

completion.size, cs, completionSize

Размер завершения, например 0b.

fielddata.memory_size, fm, fielddataMemory

Используемая память кэша fielddata, например 0b.

fielddata.evictions, fe, fielddataEvictions

Вытеснения кэша fielddata, например 0.

query_cache.memory_size, qcm, queryCacheMemory

Используемая память кэша запросов, например 0b.

query_cache.evictions, qce, queryCacheEvictions

Вытеснения кэша запросов, например 0.

query_cache.hit_count, qchc, queryCacheHitCount

Количество попаданий в кэш запросов, например 0.

query_cache.miss_count, qcmc, queryCacheMissCount

Количество промахов кэша запросов, например 0.

request_cache.memory_size, rcm, requestCacheMemory

Используемая память кэша запросов, например 0b.

request_cache.evictions, rce, requestCacheEvictions

Вытеснения кэша запросов, например 0.

request_cache.hit_count, rchc, requestCacheHitCount

Количество попаданий в кэш запросов, например 0.

request_cache.miss_count, rcmc, requestCacheMissCount

Количество промахов кэша запросов, например 0.

flush.total, ft, flushTotal

Количество сбросов, например 1.

flush.total_time, ftt, flushTotalTime

Время, затраченное на сброс, например 1.

get.current, gc, getCurrent

Количество текущих операций получения, например 0.

get.time, gti, getTime

Время, затраченное на получение, например 14ms.

get.total, gto, getTotal

Количество операций получения, например 2.

get.exists_time, geti, getExistsTime

Время, затраченное на успешные получения, например 14ms.

get.exists_total, geto, getExistsTotal

Количество успешных операций получения, например 2.

get.missing_time, gmti, getMissingTime

Время, затраченное на неудачные получения, например 0s.

get.missing_total, gmto, getMissingTotal

Количество неудачных операций получения, например 1.

indexing.delete_current, idc, indexingDeleteCurrent

Количество текущих операций удаления, например 0.

indexing.delete_time, idti, indexingDeleteTime

Время, затраченное на удаления, например 2ms.

indexing.delete_total, idto, indexingDeleteTotal

Количество операций удаления, например 2.

indexing.index_current, iic, indexingIndexCurrent

Количество текущих операций индексирования, например 0.

indexing.index_time, iiti, indexingIndexTime

Время, затраченное на индексирование, например 134ms.

indexing.index_total, iito, indexingIndexTotal

Количество операций индексирования, например 1.

indexing.index_failed, iif, indexingIndexFailed

Количество неудачных операций индексирования, например 0.

merges.current, mc, mergesCurrent

Количество текущих операций слияния, например 0.

merges.current_docs, mcd, mergesCurrentDocs

Количество текущих документов, которые сливаются, например 0.

merges.current_size, mcs, mergesCurrentSize

Размер текущих слияний, например 0b.

merges.total, mt, mergesTotal: Количество завершённых операций слияния, таких как 0.
merges.total_docs, mtd, mergesTotalDocs: Количество объединённых документов, таких как 0.
merges.total_size, mts, mergesTotalSize: Размер текущих слияний, таких как 0b.
merges.total_time, mtt, mergesTotalTime: Время, затраченное на слияние документов, такие как 0s.
refresh.total, rto, refreshTotal: Количество обновлений, таких как 16.
refresh.time, rti, refreshTime: Время, затраченное на обновления, такие как 91ms.
script.compilations, scrcc, scriptCompilations: Общее количество компиляций скриптов, такие как 17.
script.cache_evictions, scrce, scriptCacheEvictions: Общее количество скомпилированных скриптов, удаленных из кэша, такие как 6.
search.fetch_current, sfc, searchFetchCurrent: Текущие операции фазы извлечения, такие как 0.
search.fetch_time, sfti, searchFetchTime: Время, затраченное на фазу извлечения, такие как 37ms.
search.fetch_total, sfto, searchFetchTotal: Количество операций извлечения, такие как 7.
search.open_contexts, so, searchOpenContexts: Открытые контексты поиска, такие как 0.
search.query_current, sqc, searchQueryCurrent: Текущие операции фазы запроса, такие как 0.
search.query_time, sqti, searchQueryTime: Время, затраченное на фазу запроса, такие как 43ms.
search.query_total, sqto, searchQueryTotal: Количество операций запроса, такие как 9.
search.scroll_current, scc, searchScrollCurrent: Открытые контексты прокрутки, такие как 2.
search.scroll_time, scti, searchScrollTime: Время, в течение которого контексты прокрутки оставались открытыми, такие как 2m.
search.scroll_total, scto, searchScrollTotal: Завершенные контексты прокрутки, такие как 1.
segments.count, sc, segmentsCount: Количество сегментов, такие как 4.
segments.memory, sm, segmentsMemory: Память, используемая сегментами, такие как 1.4kb.
segments.index_writer_memory, siwm, segmentsIndexWriterMemory: Память, используемая модулем записи индекса, такие как 18mb.
segments.version_map_memory, svmm, segmentsVersionMapMemory: Память, используемая отображением версий, такие как 1.0kb.
segments.fixed_bitset_memory, sfbm, fixedBitsetMemory: Память, используемая наборами фиксированных битов для вложенных типов полей объектов и фильтрами типов для типов, упоминаемых в полях join, такие как 1.0kb.
suggest.current, suc, suggestCurrent: Количество текущих операций предложений, такие как 0.
suggest.time, suti, suggestTime: Время, затраченное на предложения, такие как 0.
suggest.total, suto, suggestTotal: Количество операций предложений, такие как 0.

help

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

local

(Необязательно, булево) [7.6.0] Устарело в 7.6.0. Этот параметр не заставляет этот API действовать локально. Он будет удалён в версии 8.0. Если true, запрос вычисляет список выбранных узлов из состояния локального кластера. По умолчанию false, что означает, что список выбранных узлов вычисляется из состояния кластера на главном узле. В любом случае координирующий узел отправляет запрос о дополнительной информации каждому выбранному узлу.

master_timeout

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

s

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

time

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

v

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

include_unloaded_segments

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

Примеры

Пример со столбцами по умолчанию

GET /_cat/nodes?v=true

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

ip        heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name
127.0.0.1           65          99  42    3.07                  dim       *      mJw06l1

Столбцы ip, heap.percent, ram.percent, cpu и load_* предоставляют адреса IP-адресов и информацию о производительности каждого узла.

Столбцы node.role, master и name предоставляют информацию, полезную для мониторинга всего кластера, особенно больших.

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

Следующий запрос API возвращает столбцы id, ip, port, v (версия) и m (главный).

GET /_cat/nodes?v=true&h=id,ip,port,v,m

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

id   ip        port  v         m
veJR 127.0.0.1 59938 7.17.28 *

© 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-nodes.html