› › ›

API cat nodeattrs

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

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

Запрос

GET /_cat/nodeattrs

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

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

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

format

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

h

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

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

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

node,name: (По умолчанию) Имя узла, например, DKDM97B.
host, h: (По умолчанию) Имя хоста, например, n1.
ip, i: (По умолчанию) IP-адрес, например, 127.0.1.1.
attr, attr.name: (По умолчанию) Имя атрибута, например, rack.
value, attr.value: (По умолчанию) Значение атрибута, например, rack123.
id, nodeId: ID узла, например, k0zy.
pid, p: ID процесса, например, 13061.
port, po: Порт транспортного соединения, например, 9300.

help

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

local

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

master_timeout

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

s

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

v

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

Примеры

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

GET /_cat/nodeattrs?v=true

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

node    host      ip        attr     value
...
node-0 127.0.0.1 127.0.0.1 testattr test
...

Столбцы node, host и ip предоставляют основную информацию о каждом узле. Столбцы attr и value возвращают пользовательские атрибуты узлов, по одному на строке.

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

Следующий запрос API возвращает столбцы name, pid, attr и value.

GET /_cat/nodeattrs?v=true&h=name,pid,attr,value

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

name    pid   attr     value
...
node-0 19566 testattr test
...

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