OpenSearch/docs/reference/cat/alias.asciidoc

[[cat-alias]]
== cat aliases

`aliases` shows information about currently configured aliases to indices
including filter and routing infos.

[source,sh]
--------------------------------------------------
% curl '192.168.56.10:9200/_cat/aliases?v'
alias  index filter routing.index routing.search
alias2 test1 *      -            -
alias4 test1 -      2            1,2
alias1 test1 -      -            -
alias3 test1 -      1            1
--------------------------------------------------

The output shows that `alias` has configured a filter, and specific routing
configurations in `alias3` and `alias4`.

If you only want to get information about a single alias, you can specify
the alias in the URL, for example `/_cat/aliases/alias1`.
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00			`[[cat-alias]]`
[DOCS] Renamed the "cat" chapters to be more searchable 2014-05-16 15:43:35 -04:00			`== cat aliases`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00
			`aliases` shows information about currently configured aliases to indices
			`including filter and routing infos.`

Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting 2015-07-14 12:14:09 -04:00			`[source,sh]`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00			`--------------------------------------------------`
			`% curl '192.168.56.10:9200/_cat/aliases?v'`
Names of indexRouting and searchRouting infos are out of date. Hi, I belive indexRouting should be changed to routing.index and searchRouting to routing.search. This is what my ES 2.0.0-rc1 instance returns when I hit cat alias api: Let me know if I should change other versions of documentation for this issue as well(Looks to me like it always was incorrect in docs). 2015-10-15 15:55:06 -04:00			`alias index filter routing.index routing.search`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00			`alias2 test1 * - -`
			`alias4 test1 - 2 1,2`
			`alias1 test1 - - -`
			`alias3 test1 - 1 1`
			`--------------------------------------------------`

			The output shows that `alias` has configured a filter, and specific routing
[DOCS] Renamed the "cat" chapters to be more searchable 2014-05-16 15:43:35 -04:00			configurations in `alias3` and `alias4`.
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00
			`If you only want to get information about a single alias, you can specify`
			the alias in the URL, for example `/_cat/aliases/alias1`.