- (Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.
- (Optional, byte size units) Unit used to display byte values.
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
(Optional, string) Comma-separated list of column names to display.
If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns.
Valid columns are:
- (Default) Name of the index, such as
- (Default) Name of the shard.
- (Default) Shard type. Returned values are
- (Default) IP address of the segment’s shard, such as
Name of the segment, such as
_0. The segment name is derived from the segment generation and used internally to create file names in the directory of the shard.
Generation number, such as
0. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name. Generation number, such as
0. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name.
Number of non-deleted documents in the segment, such as
25. This number is based on Lucene documents and may include documents from nested fields.
Number of deleted documents in the segment, such as
0. This number is based on Lucene documents. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
Disk space used by the segment, such as
(Default) Bytes of segment data stored in memory for efficient search, such as
A value of
-1indicates Elasticsearch was unable to compute this number.
true, the segments is synced to disk. Segments that are synced can survive a hard reboot.
false, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.
true, the segment is searchable.
false, the segment has most likely been written to disk but needs a refresh to be searchable.
- (Default) Version of Lucene used to write the segment.
- (Default) If
true, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.
- ID of the node, such as
- (Optional, boolean) If
true, the response includes help information. Defaults to
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
- (Optional, boolean) If
true, the response includes column headings. Defaults to
The API returns the following response:
index shard prirep ip segment generation docs.count docs.deleted size size.memory committed searchable version compound test 0 p 127.0.0.1 _0 0 1 0 3kb 2042 false true 8.2.0 true test1 0 p 127.0.0.1 _0 0 1 0 3kb 2042 false true 8.2.0 true