Get index shard stores

GET /{index}/_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.

Path parameters

  • index string | array[string] Required

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

Query parameters

  • If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

  • expand_wildcards string | array[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.

  • If true, missing or closed indices are not included in the response.

  • status string | array[string]

    List of shard health statuses used to limit the request.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • indices object Required
      Hide indices attribute Show indices attribute object
      • * object Additional properties

        Additional properties are allowed.

        Hide * attribute Show * attribute object
        • shards object Required
          Hide shards attribute Show shards attribute object
          • * object Additional properties

            Additional properties are allowed.

            Hide * attribute Show * attribute object
            • stores array[object] Required

              Additional properties are allowed.

GET /{index}/_shard_stores
curl \
 -X GET http://api.example.com/{index}/_shard_stores
Response examples (200)
{
  "indices": {
    "additionalProperty1": {
      "shards": {
        "additionalProperty1": {
          "stores": [
            {}
          ]
        },
        "additionalProperty2": {
          "stores": [
            {}
          ]
        }
      }
    },
    "additionalProperty2": {
      "shards": {
        "additionalProperty1": {
          "stores": [
            {}
          ]
        },
        "additionalProperty2": {
          "stores": [
            {}
          ]
        }
      }
    }
  }
}