Index shard stores APIedit
Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.
GET /my-index-000001/_shard_stores
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
monitorormanageindex privilege for the target data stream, index, or alias.
Descriptionedit
The index shard stores API returns the following information:
- The node on which each replica shard exists
- Allocation ID for each replica shard
- Unique ID for each replica shard
- Any errors encountered while opening the shard index or from an earlier failure
By default, the API only returns store information for primary shards that are unassigned or have one or more unassigned replica shards.
Path parametersedit
-
<target> -
(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (
*). To target all data streams and indices, omit this parameter or use*or_all.
Query parametersedit
-
allow_no_indices -
(Optional, Boolean) If
false, the request returns an error if any wildcard expression, index alias, or_allvalue targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*returns an error if an index starts withfoobut no index starts withbar.Defaults to
true. -
expand_wildcards -
(Optional, 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 - Match any data stream or index, including hidden ones.
-
open - Match open, non-hidden indices. Also matches any non-hidden data stream.
-
closed - Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
-
hidden -
Match hidden data streams and hidden indices. Must be combined with
open,closed, or both. -
none - Wildcard patterns are not accepted.
Defaults to
open. -
-
ignore_unavailable -
(Optional, Boolean) If
false, the request returns an error if it targets a missing or closed index. Defaults tofalse. -
status -
(Optional, string) Comma-separated list of shard health statuses used to limit the request.
Valid values include:
-
green - The primary shard and all replica shards are assigned.
-
yellow - One or more replica shards are unassigned.
-
red - The primary shard is unassigned.
-
all - Return all shards, regardless of health status.
Defaults to
yellow,red. -
-
max_concurrent_shard_requests -
(Optional, integer) Maximum number of concurrent shard-level requests sent by the coordinating node. Defaults to
100. Larger values may yield a quicker response to requests that target many shards, but may also cause a larger impact on other cluster operations.
Examplesedit
Get shard store information for a specific data stream or indexedit
GET /test/_shard_stores
Get shard store information for several data streams and indicesedit
GET /test1,test2/_shard_stores
Get shard store information for all data streams and indicesedit
GET /_shard_stores
Get shard store information based on cluster healthedit
You can use the status query parameter
to limit returned information based on shard health.
The following request only returns information for assigned primary and replica shards.
GET /_shard_stores?status=green
The API returns the following response:
{
"indices": {
"my-index-000001": {
"shards": {
"0": {
"stores": [
{
"sPa3OgxLSYGvQ4oPs-Tajw": {
"name": "node_t0",
"ephemeral_id" : "9NlXRFGCT1m8tkvYCMK-8A",
"transport_address": "local[1]",
"external_id": "node_t0",
"attributes": {},
"roles": [...],
"version": "8.10.0",
"min_index_version": 7000099,
"max_index_version": 8100099
},
"allocation_id": "2iNySv_OQVePRX-yaRH_lQ",
"allocation" : "primary|replica|unused"
"store_exception": ...
}
]
}
}
}
}
}
|
The key is the corresponding shard id for the store information |
|
|
A list of store information for all copies of the shard |
|
|
The node information that hosts a copy of the store, the key is the unique node id. |
|
|
The allocation id of the store copy |
|
|
The status of the store copy, whether it is used as a primary, replica or not used at all |
|
|
Any exception encountered while opening the shard index or from earlier engine failure |