This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

CAT fielddata

Introduced 1.0

The CAT fielddata operation lists the memory size used by each field per node.

Example

  1. GET _cat/fielddata?v

copy

To limit the information to a specific field, add the field name after your query:

  1. GET _cat/fielddata/<field_name>?v

copy

If you want to get information for more than one field, separate the field names with commas:

  1. GET _cat/fielddata/field_name_1,field_name_2,field_name_3

copy

Path and HTTP methods

  1. GET _cat/fielddata?v
  2. GET _cat/fielddata/<field_name>?v

URL parameters

All CAT fielddata URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameter:

ParameterTypeDescription
bytesByte sizeSpecify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units.

Response

The following response shows the memory size for all fields as 284 bytes:

  1. id host ip node field size
  2. 1vo54NuxSxOrbPEYdkSF0w 172.18.0.4 172.18.0.4 odfe-node1 _id 284b
  3. ZaIkkUd4TEiAihqJGkp5CA 172.18.0.3 172.18.0.3 odfe-node2 _id 284b