› › ›

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.

resp = client.cat.fielddata(
    v=True,
    fields="body",
)
print(resp)

response = client.cat.fielddata(
  v: true,
  fields: 'body'
)
puts response

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

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.

resp = client.cat.fielddata(
    fields="body,soul",
    v=True,
)
print(resp)

response = client.cat.fielddata(
  fields: 'body,soul',
  v: true
)
puts response

const response = await client.cat.fielddata({
  fields: "body,soul",
  v: "true",
});
console.log(response);

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

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

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

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

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