IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Force merge API Get component template API »

› › ›

Get alias API

edit

Get alias API

edit

Retrieves information for one or more aliases.

response = client.indices.get_alias(
  index: 'my-data-stream',
  name: 'my-alias'
)
puts response

GET my-data-stream/_alias/my-alias

Request

edit

GET _alias/<alias>

GET _alias

GET <target>/_alias/<alias>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the alias. If you specify a target, you must also have view_index_metadata or manage index privilege for the target.

Path parameters

edit

<alias>: (Optional, string) Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
<target>: (Optional, string) 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.

Query parameters

edit

allow_no_indices

(Optional, 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.

Defaults to true.

expand_wildcards

(Optional, 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: 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 patterns are not accepted.

Defaults to all.

ignore_unavailable

(Optional, Boolean) If false, requests that include a missing data stream or index in the <target> return an error. 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.

« Force merge API Get component template API »