IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Index shard stores API

edit

Index shard stores API

edit

Returns store information about replica shards in one or more indices.

GET /twitter/_shard_stores

Request

edit

GET /<index>/_shard_stores

GET /_shard_stores

Description

edit

Use the index shard stores API to return store information about replica shards in one or more indices.

Returned information includes:

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 parameters

edit

<index>

(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

To retrieve information for all indices in the cluster, use a value of _all or * or omit this parameter.

Query parameters

edit

allow_no_indices

(Optional, boolean) If true, the request does not return an error if a wildcard expression or _all value retrieves only missing or closed indices.

This parameter also applies to index aliases that point to a missing or closed index.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Valid values are:

all: Expand to open and closed indices.
open: Expand only to open indices.
closed: Expand only to closed indices.
none: Wildcard expressions are not accepted.

Defaults to open.

ignore_unavailable

(Optional, boolean) If true, missing or closed indices are not included in the response. Defaults to false.

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.

Examples

edit

Get shard store information for a specific index

edit

GET /test/_shard_stores

Get shard store information for several indices

edit

GET /test1,test2/_shard_stores

Get shard store information for all indices

edit

GET /_shard_stores

Get shard store information based on cluster health

edit

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": {
           "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

« Index segments API Index stats API »