Alice Williams fe8d702ca9
add operation to titles to differentiate from the API group acronym (#1750)
* add operation to titles to differentiate from the API group acronym

Signed-off-by: alicejw <alicejw@amazon.com>

* update frontmatter with new page title

Signed-off-by: alicejw <alicejw@amazon.com>

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

Signed-off-by: alicejw <alicejw@amazon.com>

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

Signed-off-by: alicejw <alicejw@amazon.com>

* to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-31 09:21:32 -07:00

1.4 KiB

layout title parent nav_order has_children
default CAT field data CAT API 15 false

CAT fielddata

Introduced 1.0 {: .label .label-purple }

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

Example

GET _cat/fielddata?v

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

GET _cat/fielddata/<field_name>?v

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

GET _cat/aliases/field_name_1,field_name_2,field_name_3

Path and HTTP methods

GET _cat/fielddata?v
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:

Parameter Type Description
bytes Byte size Specify 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:

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