› › ›

API cat fielddata

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

Возвращает объем оперативной памяти, используемой в настоящее время кэшем данных полей на каждом узле данных в кластере.

Запрос

GET /_cat/fielddata/<field>

GET /_cat/fielddata

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

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

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

<field>: (Необязательно, строка) Список полей, разделенных запятыми, используемых для ограничения возвращаемой информации.

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

bytes: (Необязательно, единицы измерения размера байтов) Единица измерения, используемая для отображения значений байтов.
format: (Необязательно, строка) Короткая версия заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.
h: (Необязательно, строка) Список имен столбцов, разделенных запятыми, для отображения.
help: (Необязательно, логическое значение) Если true, в ответ включается справочная информация. По умолчанию false.
s: (Необязательно, строка) Список имен столбцов или псевдонимов столбцов, разделенных запятыми, используемых для сортировки ответа.
v: (Необязательно, логическое значение) Если true, в ответ включаются заголовки столбцов. По умолчанию false.

Примеры

Пример с отдельным полем

Вы можете указать отдельное поле в теле запроса или пути URL. Следующий fieldata запрос API получает информацию о размере памяти для body поля.

GET /_cat/fielddata?v=true&fields=body

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

id                     host      ip        node    field   size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body    544b

Пример со списком полей

Вы можете указать список полей, разделенных запятыми, в теле запроса или пути URL. Следующий fieldata запрос API получает информацию о размере памяти для body и soul полей.

GET /_cat/fielddata/body,soul?v=true

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

id                     host      ip        node    field   size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body    544b
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul    480b

Ответ показывает отдельные данные полей для body и soul полей, по одной строке на поле на узел.

Пример со всеми полями в кластере

Следующий fieldata запрос API получает информацию о размере памяти для всех полей.

GET /_cat/fielddata?v=true

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

id                     host      ip        node    field   size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body    544b
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in mind    360b
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul    480b

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