› › ›

API cat nodeattrs

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

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

Запрос

GET /_cat/nodeattrs

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

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

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

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: Идентификатор узла, например, k0zy.
pid, p: Идентификатор процесса, например, 13061.
port, po: Порт транспортного соединения, например, 9300.

help

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

local

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

master_timeout

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

s

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

v

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

Примеры

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

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

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

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

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.

resp = client.cat.nodeattrs(
    v=True,
    h="name,pid,attr,value",
)
print(resp)

response = client.cat.nodeattrs(
  v: true,
  h: 'name,pid,attr,value'
)
puts response

const response = await client.cat.nodeattrs({
  v: "true",
  h: "name,pid,attr,value",
});
console.log(response);

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