Skip to content

Latest commit

 

History

History
215 lines (167 loc) · 5.92 KB

shard-stores.asciidoc

File metadata and controls

215 lines (167 loc) · 5.92 KB

Index shard stores API

Index shard stores
New API reference

For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs].

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

{api-request-title}

GET /<target>/_shard_stores

GET /_shard_stores

{api-prereq-title}

  • If the {es} {security-features} are enabled, you must have the monitor or manage index privilege for the target data stream, index, or alias.

{api-description-title}

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.

{api-path-parms-title}

<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.

{api-query-parms-title}

+ Defaults to true.

+ Defaults to open.

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.

{api-examples-title}

Get shard store information for a specific data stream or index
GET /test/_shard_stores
Get shard store information for several data streams and indices
GET /test1,test2/_shard_stores
Get shard store information for all data streams and indices
GET /_shard_stores
Get shard store information based on cluster health

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": { (1)
                "stores": [ (2)
                    {
                        "sPa3OgxLSYGvQ4oPs-Tajw": { (3)
                            "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", (4)
                        "allocation" : "primary|replica|unused" (5)
                        "store_exception": ... (6)
                    }
                ]
              }
           }
       }
   }
}
  1. The key is the corresponding shard id for the store information

  2. A list of store information for all copies of the shard

  3. The node information that hosts a copy of the store, the key is the unique node id.

  4. The allocation id of the store copy

  5. The status of the store copy, whether it is used as a primary, replica or not used at all

  6. Any exception encountered while opening the shard index or from earlier engine failure