WARNING: Version 6.2 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Indices Shard Stores
editIndices Shard Stores
editProvides store information for shard copies of indices. Store information reports on which nodes shard copies exist, the shard copy allocation ID, a unique identifier for each shard copy, and any exceptions encountered while opening the shard index or from earlier engine failure.
By default, only lists store information for shards that have at least one unallocated copy. When the cluster health status is yellow, this will list store information for shards that have at least one unassigned replica. When the cluster health status is red, this will list store information for shards, which has unassigned primaries.
Endpoints include shard stores information for a specific index, several indices, or all:
# return information of only index test GET /test/_shard_stores # return information of only test1 and test2 indices GET /test1,test2/_shard_stores # return information of all indices GET /_shard_stores
The scope of shards to list store information can be changed through
status
param. Defaults to yellow and red. yellow lists store information of
shards with at least one unassigned replica and red for shards with unassigned
primary shard.
Use green to list store information for shards with all assigned copies.
GET /_shard_stores?status=green
Response:
The shard stores information is grouped by indices and shard ids.
{ "indices": { "my-index": { "shards": { "0": { "stores": [ { "sPa3OgxLSYGvQ4oPs-Tajw": { "name": "node_t0", "ephemeral_id" : "9NlXRFGCT1m8tkvYCMK-8A", "transport_address": "local[1]", "attributes": {} }, "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 |