elasticsearch/docs/reference/indices/get-alias.asciidoc
Liam Thompson 33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00

62 lines
1.7 KiB
Text

[[indices-get-alias]]
=== Get alias API
++++
<titleabbrev>Get alias</titleabbrev>
++++
Retrieves information for one or more <<aliases,aliases>>.
[source,console]
----
GET my-data-stream/_alias/my-alias
----
// TEST[setup:my_data_stream]
// TEST[s/^/PUT my-data-stream\/_alias\/my-alias\n/]
// TEST[teardown:data_stream_cleanup]
[[get-alias-api-request]]
==== {api-request-title}
`GET _alias/<alias>`
`GET _alias`
`GET <target>/_alias/<alias>`
[[get-alias-api-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the
`view_index_metadata` or `manage` <<privileges-list-indices,index privilege>>
for the alias. If you specify a target, you must also have `view_index_metadata`
or `manage` index privilege for the target.
[[get-alias-api-path-params]]
==== {api-path-parms-title}
`<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`.
[[get-alias-api-query-params]]
==== {api-query-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
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`.
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]