› › ›

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) Используемая процентная доля от общего выделенного куска памяти JVM Elasticsearch, например, 7. Это отражает только процесс Elasticsearch, работающий в операционной системе, и является самым прямым показателем производительности ресурсов JVM/куска памяти/памяти.

heap.max, hm, heapMax

Общий кусок памяти, например, 4gb.

ram.percent, rp, ramPercent

(Default) Используемая процентная доля от общей оперативной памяти системы, например, 47. Это отражает все процессы, работающие в операционной системе, а не только Elasticsearch, и не гарантирует корреляции с производительностью.

file_desc.percent, fdp, fileDescriptorPercent

Процент использования файлов-дескрипторов, например, 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, например, 8.17.3.

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

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

load_1m, l

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

load_5m, l

(Default) Среднее значение загрузки за последние пять минут, например, 0.78.

load_15m, l

(Default) Среднее значение загрузки за последние пятнадцать минут, например, 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.
shard_stats.total_count, sstc, shards, shardStatsTotalCount: Количество назначенных фрагментов.
mappings.total_count, mtc, mappingsTotalCount: Количество отображений, включая поля runtime и object.
mappings.total_estimated_overhead_in_bytes, mteo, mappingsTotalEstimatedOverheadInBytes: Оценённые накладные расходы памяти, в байтах, отображений на этом узле, которые позволяют 1 КБ памяти для каждого отображаемого поля.

help

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

master_timeout

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

s

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

time

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

v

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

include_unloaded_segments

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

Примеры

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

resp = client.cat.nodes(
    v=True,
)
print(resp)

response = client.cat.nodes(
  v: true
)
puts response

const response = await client.cat.nodes({
  v: "true",
});
console.log(response);

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 (мастер).

resp = client.cat.nodes(
    v=True,
    h="id,ip,port,v,m",
)
print(resp)

response = client.cat.nodes(
  v: true,
  h: 'id,ip,port,v,m'
)
puts response

const response = await client.cat.nodes({
  v: "true",
  h: "id,ip,port,v,m",
});
console.log(response);

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

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

id   ip        port  v         m
veJR 127.0.0.1 59938 8.17.3 *

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

END_OF_DOCUMENT_MARKER