IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Alias exists API
editAlias exists APIedit
Checks if an alias exists.
response = client.indices.exists_alias( name: 'my-alias' ) puts response
HEAD _alias/my-alias
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
view_index_metadata
ormanage
index privilege for the alias. If you specify a target, you must also have theview_index_metadata
ormanage
index privilege for the target.
Path parametersedit
-
<alias>
-
(Optional, string) Comma-separated list of aliases to check. Supports wildcards
(
*
). -
<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 parametersedit
-
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 tofalse
. -
local
-
(Optional, Boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, which means information is retrieved from the master node.
Response codesedit
-
200
- All specified aliases exist.
-
404
- One or more of the specified aliases don’t exist.