Search Shards API

Returns the indices and shards that a search request would be executed against.

  1. GET /my-index-000001/_search_shards

Request

GET /<index>/_search_shards

Description

The search shards api returns the indices and shards that a search request would be executed against. This can give useful feedback for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

Path parameters

<index>

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

Query parameters

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.

Defaults to true.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in open,hidden. Valid values are:

  • all

    Expand to open and closed indices, including hidden indices.

    open

    Expand only to open indices.

    closed

    Expand only to closed indices.

    hidden

    Expansion of wildcards will include hidden indices. Must be combined with open, closed, or both.

    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.

local

(Optional, boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

preference

(Optional, string) Specifies the node or shard the operation should be performed on. Random by default.

routing

(Optional, string) Target the specified primary shard.

Examples

  1. GET /my-index-000001/_search_shards

The API returns the following result:

  1. {
  2.   "nodes": ...,
  3.   "indices" : {
  4.     "my-index-000001": { }
  5.   },
  6.   "shards": [
  7.     [
  8.       {
  9.         "index": "my-index-000001",
  10.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  11.         "primary": true,
  12.         "shard": 0,
  13.         "state": "STARTED",
  14.         "allocation_id": {"id":"0TvkCyF7TAmM1wHP4a42-A"},
  15.         "relocating_node": null
  16.       }
  17.     ],
  18.     [
  19.       {
  20.         "index": "my-index-000001",
  21.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  22.         "primary": true,
  23.         "shard": 1,
  24.         "state": "STARTED",
  25.         "allocation_id": {"id":"fMju3hd1QHWmWrIgFnI4Ww"},
  26.         "relocating_node": null
  27.       }
  28.     ],
  29.     [
  30.       {
  31.         "index": "my-index-000001",
  32.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  33.         "primary": true,
  34.         "shard": 2,
  35.         "state": "STARTED",
  36.         "allocation_id": {"id":"Nwl0wbMBTHCWjEEbGYGapg"},
  37.         "relocating_node": null
  38.       }
  39.     ],
  40.     [
  41.       {
  42.         "index": "my-index-000001",
  43.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  44.         "primary": true,
  45.         "shard": 3,
  46.         "state": "STARTED",
  47.         "allocation_id": {"id":"bU_KLGJISbW0RejwnwDPKw"},
  48.         "relocating_node": null
  49.       }
  50.     ],
  51.     [
  52.       {
  53.         "index": "my-index-000001",
  54.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  55.         "primary": true,
  56.         "shard": 4,
  57.         "state": "STARTED",
  58.         "allocation_id": {"id":"DMs7_giNSwmdqVukF7UydA"},
  59.         "relocating_node": null
  60.       }
  61.     ]
  62.   ]
  63. }

Specifying the same request, this time with a routing value:

  1. GET /my-index-000001/_search_shards?routing=foo,bar

The API returns the following result:

  1. {
  2.   "nodes": ...,
  3.   "indices" : {
  4.       "my-index-000001": { }
  5.   },
  6.   "shards": [
  7.     [
  8.       {
  9.         "index": "my-index-000001",
  10.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  11.         "primary": true,
  12.         "shard": 2,
  13.         "state": "STARTED",
  14.         "allocation_id": {"id":"fMju3hd1QHWmWrIgFnI4Ww"},
  15.         "relocating_node": null
  16.       }
  17.     ],
  18.     [
  19.       {
  20.         "index": "my-index-000001",
  21.         "node": "JklnKbD7Tyqi9TP3_Q_tBg",
  22.         "primary": true,
  23.         "shard": 3,
  24.         "state": "STARTED",
  25.         "allocation_id": {"id":"0TvkCyF7TAmM1wHP4a42-A"},
  26.         "relocating_node": null
  27.       }
  28.     ]
  29.   ]
  30. }

Because of the specified routing values, the search is only executed against two of the shards.