Get index shard stores

GET /{index}/_shard_stores
GET /_shard_stores

Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices.

The index shard stores API returns the following information:

The node on which each replica shard exists.
The allocation ID for each replica shard.
A unique ID for each replica shard.
Any errors encountered while opening the shard index or from an earlier failure.

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

Required authorization

Index privileges: monitor

Path Parameters

index union IndexName | [] IndexName optional

List of data streams, indices, and aliases used to limit the request.

Leave it out to use /_shard_stores.

Query Parameters

Response

application/json

Examples

An abbreviated response from GET /_shard_stores?status=green.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_shard_stores?status=green

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.shardStores({
  status: "green",
});

Python Elasticsearch Python Client

resp = client.indices.shard_stores(
    status="green",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_shard_stores?status=green" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

C# Elasticsearch .NET Client

var response = await client.Indices
    .ShardStoresAsync(d1 => d1
        .Status(ShardStoreStatus.Green)
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->shardStores([
    "status" => "green",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.shard_stores(
  status: "green"
)

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",
              "store_exception": {}
            }
          ]
        }
      }
    }
  }
}

Required authorization

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , ignore_unavailable , status , }

Response

Query Parameters