Get the search shards | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

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

• 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.
• 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.
  Supported values include:
  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.
• If false, the request returns an error if it targets a missing or closed index.
• If true, the request retrieves information from the local node only.
• 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.
• The node or shard the operation should be performed on. It is random by default.
• A custom value used to route operations to a specific shard.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • Hide nodes attribute Show nodes attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * 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.
  • Hide shards attributes Show shards attributes object
    * Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.
    * Hide allocation_id attribute Show allocation_id attribute object
    * Hide recovery_source attribute Show recovery_source attribute object
    * Hide unassigned_info attributes Show unassigned_info attributes object
    * 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.
    * Hide relocation_failure_info attribute Show relocation_failure_info attribute object
  • Hide indices attribute Show indices attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
    External documentation