Get index segments
Generally available
Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices.
Required authorization
- Index privileges:
monitor
Query parameters
-
allow_no_indices
boolean If
false
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. -
expand_wildcards
string | array[string] Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as
open,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.Values are
all
,open
,closed
,hidden
, ornone
.
GET
/_segments
Console
GET /my-index-000001/_segments
resp = client.indices.segments(
index="my-index-000001",
)
const response = await client.indices.segments({
index: "my-index-000001",
});
response = client.indices.segments(
index: "my-index-000001"
)
$resp = $client->indices()->segments([
"index" => "my-index-000001",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index-000001/_segments"
Response examples (200)
A successful response for creating a new index for a data stream.
{
"acknowledged": true,
"shards_acknowledged": true,
"old_index": ".ds-my-data-stream-2099.05.06-000001",
"new_index": ".ds-my-data-stream-2099.05.07-000002",
"rolled_over": true,
"dry_run": false,
"lazy": false,
"conditions": {
"[max_age: 7d]": false,
"[max_docs: 1000]": true,
"[max_primary_shard_size: 50gb]": false,
"[max_primary_shard_docs: 2000]": false
}
}