cat fielddata API
Returns the amount of heap memory currently used by fielddata on every data node in the cluster.
Request
GET /_cat/fielddata/<field>
GET /_cat/fielddata
Path parameters
<field>
(Optional, string) Comma-separated list of fields used to limit returned information.
Query parameters
bytes
(Optional, byte size units) Unit used to display byte values.
format
(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
h
(Optional, string) Comma-separated list of column names to display.
help
(Optional, boolean) If true
, the response includes help information. Defaults to false
.
s
(Optional, string) Comma-separated list of column names or column aliases used to sort the response.
v
(Optional, boolean) If true
, the response includes column headings. Defaults to false
.
Examples
Example with an individual field
You can specify an individual field in the request body or URL path. The following fieldata
API request retrieves heap memory size information for the body
field.
GET /_cat/fielddata?v&fields=body
The API returns the following response:
id host ip node field size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b
Example with a list of fields
You can specify a comma-separated list of fields in the request body or URL path. The following fieldata
API request retrieves heap memory size information for the body
and soul
fields.
GET /_cat/fielddata/body,soul?v
The API returns the following response:
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
The response shows the individual fielddata for the body
and soul
fields, one row per field per node.
Example with all fields in a cluster
The following fieldata
API request retrieves heap memory size information all fields.
GET /_cat/fielddata?v
The API returns the following response:
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