Get aliases | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

• index
  string | array[string] Required
  Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
• name
  string | array[string] Required
  Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, 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.
• 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.
• Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • *
    object Additional properties
    Hide * attribute Show * attribute object
    * Hide aliases attribute Show aliases attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
    External documentation
    * Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
    * If true, the index is the write index for the alias.
    * Value used to route indexing and search operations to a specific shard.
    * Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
    * is_hidden
    boolean Generally available; Added in 7.16.0
    If true, the alias is hidden. All indices for the alias must have the same is_hidden value.