Get field data cache information

  • GET /_cat/fielddata/{fields}
  • GET /_cat/fielddata
Auth

Get the amount of heap memory currently used by the field data cache on every data node in the cluster.

Important

cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.

Required authorization

Cluster privileges monitor

Path parameters

fields union string | string[] optional

Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.

Leave it out to use /_cat/fielddata.

Query parameters

fields union string | string[]

Comma-separated list of fields used to limit returned information.

h union oneOf

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

  • id: The node ID.
  • host (or h): The host name of the node.
  • ip: The IP address of the node.
  • node (or n): The node name.
  • field (or f): The field name.
  • size (or s): The field data usage.
Values: id host h ip node n field f size s
s union string | string[]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb
time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json
<array> object[]
id string

node id

host string

host name

ip string

ip address

node string

node name

field string

field name

size string

field data usage