Get the search shards | Elasticsearch API documentation (8x-unreleased)

Get the search shards Generally available

POST /{index}/_search_shards

Get the indices and shards that a search request would be run against. This information can be useful 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.

If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or alias. ##Required authorization

Index privileges: view_index_metadata

Path parameters

index string | array[string] Required

A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*). To search all data streams and indices, omit this parameter or use * or _all.

Query parameters

allow_no_indices boolean

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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
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. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

Values are all, open, closed, hidden, or none.
ignore_unavailable boolean

If false, the request returns an error if it targets a missing or closed index.
local boolean

If true, the request retrieves information from the local node only.
master_timeout string

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. IT can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.
preference string

The node or shard the operation should be performed on. It is random by default.
routing string

A custom value used to route operations to a specific shard.

Responses

200 application/json
Hide response attributes Show response attributes object
- nodes object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  name string Required
  
  ephemeral_id string Required
  
  transport_address string Required
  
  external_id string Required Generally available; Added in 8.3.0
  
  attributes object Required
  
  Lists node attributes.
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  roles array[string] Required
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  version string Required
  
  min_index_version number Required
  
  max_index_version number Required
- shards array[array] Required
  
  Hide shards attributes Show shards attributes object
  
  state string Required
  
  Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.
  
  primary boolean Required
  
  node string
  
  shard number Required
  
  index string Required
  
  allocation_id object
  
  Hide allocation_id attribute Show allocation_id attribute object
  
  * string
  
  recovery_source object
  
  Hide recovery_source attribute Show recovery_source attribute object
  
  * string
  
  unassigned_info object
  
  Hide unassigned_info attributes Show unassigned_info attributes object
  
  at string
  
  last_allocation_status string
  
  reason string Required
  
  Values are INDEX_CREATED, CLUSTER_RECOVERED, INDEX_REOPENED, DANGLING_INDEX_IMPORTED, NEW_INDEX_RESTORED, EXISTING_INDEX_RESTORED, REPLICA_ADDED, ALLOCATION_FAILED, NODE_LEFT, REROUTE_CANCELLED, REINITIALIZED, REALLOCATED_REPLICA, PRIMARY_FAILED, FORCED_EMPTY_PRIMARY, or MANUAL_ALLOCATION.
  
  details string
  
  failed_allocation_attempts number
  
  delayed boolean
  
  allocation_status string
  
  relocating_node string | null
  
  One of:
  NodeId string string-2 string | null
  
  relocation_failure_info object
  
  Hide relocation_failure_info attribute Show relocation_failure_info attribute object
  
  failed_attempts number Required
- indices object Required
  
  Hide indices attribute Show indices attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  aliases array[string]
  
  filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  Hide filter attributes Show filter attributes object
  
  bool object
  
  Hide bool attributes Show bool attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  filter
  
  minimum_should_match
  
  must
  
  must_not
  
  should
  
  boosting object
  
  Hide boosting attributes Show boosting attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  negative_boost number Required
  
  Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.
  
  negative object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  positive object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  common object Deprecated
  
  combined_fields object
  
  Hide combined_fields attributes Show combined_fields attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  fields array[string] Required
  
  List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.
  
  query string Required
  
  Text to search for in the provided fields. The combined_fields query analyzes the provided text before performing a search.
  
  auto_generate_synonyms_phrase_query boolean
  
  If true, match phrase queries are automatically created for multi-term synonyms.
  
  operator string
  
  Values are or or and.
  
  minimum_should_match
  
  zero_terms_query string
  
  Values are none or all.
  
  constant_score object
  
  Hide constant_score attributes Show constant_score attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  filter object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  dis_max object
  
  Hide dis_max attributes Show dis_max attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  queries array[object] Required
  
  One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.
  
  tie_breaker number
  
  Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.
  
  distance_feature object
  
  One of:
  UntypedDistanceFeatureQuery object GeoDistanceFeatureQuery object DateDistanceFeatureQuery object
  
  exists object
  
  Hide exists attributes Show exists attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  function_score object
  
  Hide function_score attributes Show function_score attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  boost_mode string
  
  Values are multiply, replace, sum, avg, max, or min.
  
  functions array[object]
  
  One or more functions that compute a new score for each document returned by the query.
  
  max_boost number
  
  Restricts the new score to not exceed the provided limit.
  
  min_score number
  
  Excludes documents that do not meet the provided score threshold.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  score_mode string
  
  Values are multiply, sum, avg, first, max, or min.
  
  fuzzy object
  
  Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
  
  External documentation
  
  geo_bounding_box object
  
  Hide geo_bounding_box attributes Show geo_bounding_box attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  type string
  
  Values are memory or indexed.
  
  validation_method string
  
  Values are coerce, ignore_malformed, or strict.
  
  ignore_unmapped boolean
  
  Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.
  
  geo_distance object
  
  Hide geo_distance attributes Show geo_distance attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  distance string Required
  
  distance_type string
  
  Values are arc or plane.
  
  validation_method string
  
  Values are coerce, ignore_malformed, or strict.
  
  ignore_unmapped boolean
  
  Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.
  
  geo_grid object
  
  Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.
  
  geo_polygon object
  
  Hide geo_polygon attributes Show geo_polygon attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  validation_method string
  
  Values are coerce, ignore_malformed, or strict.
  
  ignore_unmapped boolean
  
  geo_shape object
  
  Hide geo_shape attributes Show geo_shape attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  ignore_unmapped boolean
  
  Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.
  
  has_child object
  
  Hide has_child attributes Show has_child attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  ignore_unmapped boolean
  
  Indicates whether to ignore an unmapped type and not return any documents instead of an error.
  
  inner_hits object
  
  max_children number
  
  Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.
  
  min_children number
  
  Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  score_mode string
  
  Values are none, avg, sum, max, or min.
  
  type string Required
  
  has_parent object
  
  Hide has_parent attributes Show has_parent attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  ignore_unmapped boolean
  
  Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the parent_type.
  
  inner_hits object
  
  parent_type string Required
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  score boolean
  
  Indicates whether the relevance score of a matching parent document is aggregated into its child documents.
  
  ids object
  
  Hide ids attributes Show ids attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  values
  
  intervals object
  
  Returns documents based on the order and proximity of matching terms.
  
  External documentation
  
  knn object
  
  Hide knn attributes Show knn attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  query_vector array[number]
  
  query_vector_builder object
  
  num_candidates number
  
  The number of nearest neighbor candidates to consider per shard
  
  k number
  
  The final number of nearest neighbors to return as top hits
  
  filter
  
  similarity number
  
  The minimum similarity for a vector to be considered a match
  
  rescore_vector object
  
  match object
  
  Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
  
  External documentation
  
  match_all object
  
  Hide match_all attributes Show match_all attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  match_bool_prefix object
  
  Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.
  
  External documentation
  
  match_none object
  
  Hide match_none attributes Show match_none attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  match_phrase object
  
  Analyzes the text and creates a phrase query out of the analyzed text.
  
  External documentation
  
  match_phrase_prefix object
  
  Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
  
  External documentation
  
  more_like_this object
  
  Hide more_like_this attributes Show more_like_this attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  analyzer string
  
  The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.
  
  boost_terms number
  
  Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).
  
  fail_on_unsupported_field boolean
  
  Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword).
  
  fields array[string]
  
  A list of fields to fetch and analyze the text from. Defaults to the index.query.default_field index setting, which has a default value of *.
  
  include boolean
  
  Specifies whether the input documents should also be included in the search results returned.
  
  like
  
  max_doc_freq number
  
  The maximum document frequency above which the terms are ignored from the input document.
  
  max_query_terms number
  
  The maximum number of query terms that can be selected.
  
  max_word_length number
  
  The maximum word length above which the terms are ignored. Defaults to unbounded (0).
  
  min_doc_freq number
  
  The minimum document frequency below which the terms are ignored from the input document.
  
  minimum_should_match
  
  min_term_freq number
  
  The minimum term frequency below which the terms are ignored from the input document.
  
  min_word_length number
  
  The minimum word length below which the terms are ignored.
  
  routing string
  
  stop_words
  
  unlike
  
  version number
  
  version_type string
  
  Values are internal, external, external_gte, or force.
  
  multi_match object
  
  Hide multi_match attributes Show multi_match attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  analyzer string
  
  Analyzer used to convert the text in the query value into tokens.
  
  auto_generate_synonyms_phrase_query boolean
  
  If true, match phrase queries are automatically created for multi-term synonyms.
  
  cutoff_frequency number Deprecated
  
  fields string | array[string]
  
  fuzziness
  
  fuzzy_rewrite string
  
  fuzzy_transpositions boolean
  
  If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). Can be applied to the term subqueries constructed for all terms but the final term.
  
  lenient boolean
  
  If true, format-based errors, such as providing a text query value for a numeric field, are ignored.
  
  max_expansions number
  
  Maximum number of terms to which the query will expand.
  
  minimum_should_match
  
  operator string
  
  Values are and, AND, or, or OR.
  
  prefix_length number
  
  Number of beginning characters left unchanged for fuzzy matching.
  
  query string Required
  
  Text, number, boolean value or date you wish to find in the provided field.
  
  slop number
  
  Maximum number of positions allowed between matching tokens.
  
  tie_breaker number
  
  Determines how scores for each per-term blended query and scores across groups are combined.
  
  type string
  
  Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.
  
  zero_terms_query string
  
  Values are all or none.
  
  nested object
  
  Hide nested attributes Show nested attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  ignore_unmapped boolean
  
  Indicates whether to ignore an unmapped path and not return any documents instead of an error.
  
  inner_hits object
  
  path string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  score_mode string
  
  Values are none, avg, sum, max, or min.
  
  parent_id object
  
  Hide parent_id attributes Show parent_id attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  id string
  
  ignore_unmapped boolean
  
  Indicates whether to ignore an unmapped type and not return any documents instead of an error.
  
  type string
  
  percolate object
  
  Hide percolate attributes Show percolate attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  document object
  
  The source of the document being percolated.
  
  documents array[object]
  
  An array of sources of the documents being percolated.
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  id string
  
  index string
  
  name string
  
  The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.
  
  preference string
  
  Preference used to fetch document to percolate.
  
  routing string
  
  version number
  
  pinned object
  
  Hide pinned attributes Show pinned attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  prefix object
  
  Returns documents that contain a specific prefix in a provided field.
  
  External documentation
  
  query_string object
  
  Hide query_string attributes Show query_string attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  allow_leading_wildcard boolean
  
  If true, the wildcard characters * and ? are allowed as the first character of the query string.
  
  analyzer string
  
  Analyzer used to convert text in the query string into tokens.
  
  analyze_wildcard boolean
  
  If true, the query attempts to analyze wildcard terms in the query string.
  
  auto_generate_synonyms_phrase_query boolean
  
  If true, match phrase queries are automatically created for multi-term synonyms.
  
  default_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  default_operator string
  
  Values are and, AND, or, or OR.
  
  enable_position_increments boolean
  
  If true, enable position increments in queries constructed from a query_string search.
  
  escape boolean
  
  fields array[string]
  
  Array of fields to search. Supports wildcards (*).
  
  fuzziness
  
  fuzzy_max_expansions number
  
  Maximum number of terms to which the query expands for fuzzy matching.
  
  fuzzy_prefix_length number
  
  Number of beginning characters left unchanged for fuzzy matching.
  
  fuzzy_rewrite string
  
  fuzzy_transpositions boolean
  
  If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).
  
  lenient boolean
  
  If true, format-based errors, such as providing a text value for a numeric field, are ignored.
  
  max_determinized_states number
  
  Maximum number of automaton states required for the query.
  
  minimum_should_match
  
  phrase_slop number
  
  Maximum number of positions allowed between matching tokens for phrases.
  
  query string Required
  
  Query string you wish to parse and use for search.
  
  quote_analyzer string
  
  Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the analyzer parameter.
  
  quote_field_suffix string
  
  Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.
  
  rewrite string
  
  tie_breaker number
  
  How to combine the queries generated from the individual search terms in the resulting dis_max query.
  
  time_zone string
  
  type string
  
  Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.
  
  range object
  
  Returns documents that contain terms within a provided range.
  
  External documentation
  
  rank_feature object
  
  Hide rank_feature attributes Show rank_feature attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  regexp object
  
  Returns documents that contain terms matching a regular expression.
  
  External documentation
  
  rule object
  
  Hide rule attributes Show rule attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  organic object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  ruleset_ids
  
  ruleset_id string
  
  match_criteria object Required
  
  script object
  
  Hide script attributes Show script attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  script object Required
  
  script_score object
  
  Hide script_score attributes Show script_score attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  min_score number
  
  Documents with a score lower than this floating point number are excluded from the search results.
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  script object Required
  
  semantic object
  
  Hide semantic attributes Show semantic attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  field string Required
  
  The field to query, which must be a semantic_text field type
  
  query string Required
  
  The query text
  
  shape object
  
  Hide shape attributes Show shape attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  ignore_unmapped boolean
  
  When set to true the query ignores an unmapped field and will not match any documents.
  
  simple_query_string object
  
  Hide simple_query_string attributes Show simple_query_string attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  analyzer string
  
  Analyzer used to convert text in the query string into tokens.
  
  analyze_wildcard boolean
  
  If true, the query attempts to analyze wildcard terms in the query string.
  
  auto_generate_synonyms_phrase_query boolean
  
  If true, the parser creates a match_phrase query for each multi-position token.
  
  default_operator string
  
  Values are and, AND, or, or OR.
  
  fields array[string]
  
  Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.
  
  fuzzy_max_expansions number
  
  Maximum number of terms to which the query expands for fuzzy matching.
  
  fuzzy_prefix_length number
  
  Number of beginning characters left unchanged for fuzzy matching.
  
  fuzzy_transpositions boolean
  
  If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).
  
  lenient boolean
  
  If true, format-based errors, such as providing a text value for a numeric field, are ignored.
  
  minimum_should_match
  
  query string Required
  
  Query string in the simple query string syntax you wish to parse and use for search.
  
  quote_field_suffix string
  
  Suffix appended to quoted text in the query string.
  
  span_containing object
  
  Hide span_containing attributes Show span_containing attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  big object Required
  
  little object Required
  
  span_field_masking object
  
  Hide span_field_masking attributes Show span_field_masking attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  query object Required
  
  span_first object
  
  Hide span_first attributes Show span_first attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  end number Required
  
  Controls the maximum end position permitted in a match.
  
  match object Required
  
  span_multi object
  
  Hide span_multi attributes Show span_multi attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  match object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  span_near object
  
  Hide span_near attributes Show span_near attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  clauses array[object] Required
  
  Array of one or more other span type queries.
  
  in_order boolean
  
  Controls whether matches are required to be in-order.
  
  slop number
  
  Controls the maximum number of intervening unmatched positions permitted.
  
  span_not object
  
  Hide span_not attributes Show span_not attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  dist number
  
  The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.
  
  exclude object Required
  
  include object Required
  
  post number
  
  The number of tokens after the include span that can’t have overlap with the exclude span.
  
  pre number
  
  The number of tokens before the include span that can’t have overlap with the exclude span.
  
  span_or object
  
  Hide span_or attributes Show span_or attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  clauses array[object] Required
  
  Array of one or more other span type queries.
  
  span_term object
  
  Matches spans containing a term.
  
  External documentation
  
  span_within object
  
  Hide span_within attributes Show span_within attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  big object Required
  
  little object Required
  
  sparse_vector object
  
  Hide sparse_vector attributes Show sparse_vector attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  term object
  
  Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
  
  External documentation
  
  terms object
  
  Hide terms attributes Show terms attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  terms_set object
  
  Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
  
  External documentation
  
  text_expansion object Deprecated Generally available; Added in 8.8.0
  
  Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
  
  External documentation
  
  weighted_tokens object Deprecated Generally available; Added in 8.13.0
  
  Supports returning text_expansion query results by sending in precomputed tokens with the query.
  
  External documentation
  
  wildcard object
  
  Returns documents that contain terms matching a wildcard pattern.
  
  External documentation
  
  wrapper object
  
  Hide wrapper attributes Show wrapper attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  query string Required
  
  A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings
  
  type object
  
  Hide type attributes Show type attributes object
  
  boost number
  
  Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
  
  _name string
  
  value string Required

POST /{index}/_search_shards

GET /my-index-000001/_search_shards

curl \
 --request POST 'http://api.example.com/{index}/_search_shards'

Response examples (200)

An abbreviated response from `GET /my-index-000001/_search_shards`.

{
  "nodes": {},
  "indices": {
      "my-index-000001": { }
  },
  "shards": [
      [
      {
          "index": "my-index-000001",
          "node": "JklnKbD7Tyqi9TP3_Q_tBg",
          "relocating_node": null,
          "primary": true,
          "shard": 0,
          "state": "STARTED",
          "allocation_id": {"id":"0TvkCyF7TAmM1wHP4a42-A"},
          "relocation_failure_info" : {
          "failed_attempts" : 0
          }
      }
      ],
      [
      {
          "index": "my-index-000001",
          "node": "JklnKbD7Tyqi9TP3_Q_tBg",
          "relocating_node": null,
          "primary": true,
          "shard": 1,
          "state": "STARTED",
          "allocation_id": {"id":"fMju3hd1QHWmWrIgFnI4Ww"},
          "relocation_failure_info" : {
          "failed_attempts" : 0
          }
      }
      ],
      [
      {
          "index": "my-index-000001",
          "node": "JklnKbD7Tyqi9TP3_Q_tBg",
          "relocating_node": null,
          "primary": true,
          "shard": 2,
          "state": "STARTED",
          "allocation_id": {"id":"Nwl0wbMBTHCWjEEbGYGapg"},
          "relocation_failure_info" : {
          "failed_attempts" : 0
          }
      }
      ],
      [
      {
          "index": "my-index-000001",
          "node": "JklnKbD7Tyqi9TP3_Q_tBg",
          "relocating_node": null,
          "primary": true,
          "shard": 3,
          "state": "STARTED",
          "allocation_id": {"id":"bU_KLGJISbW0RejwnwDPKw"},
          "relocation_failure_info" : {
          "failed_attempts" : 0
          }
      }
      ],
      [
      {
          "index": "my-index-000001",
          "node": "JklnKbD7Tyqi9TP3_Q_tBg",
          "relocating_node": null,
          "primary": true,
          "shard": 4,
          "state": "STARTED",
          "allocation_id": {"id":"DMs7_giNSwmdqVukF7UydA"},
          "relocation_failure_info" : {
          "failed_attempts" : 0
          }
      }
      ]
    ]
  }

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation

Get the search shards Generally available

Path parameters

Query parameters

Responses

relocating_node string | null

distance_feature object

Documentation preview