Get field data cache information

GET /_cat/fielddata/{fields}
GET /_cat/fielddata

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 Field | [] Field 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

Response

application/json

Examples

A successful response from GET /_cat/fielddata?v=true&fields=body&format=json. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the body field.

Request Console 1 / 7 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/fielddata?v=true&fields=body&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().fielddata(f -> f
    .fields("body")
);

PHP Elasticsearch PHP Client

$resp = $client->cat()->fielddata([
    "v" => "true",
    "fields" => "body",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.fielddata(
  v: "true",
  fields: "body",
  format: "json"
)

Response

[
  {
    "id": "Nqk-6inXQq-OxUfOUI8jNQ",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "node": "Nqk-6in",
    "field": "body",
    "size": "544b"
  }
]

Required authorization

Path Parameters

Query Parameters { fields , h , s , }

Response

Query Parameters