OpenSearch/docs/reference/cat/alias.asciidoc

[[cat-alias]]
== cat aliases

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

////
Hidden setup for example:
[source,js]
--------------------------------------------------
PUT test1
{
  "aliases": {
    "alias1": {},
    "alias2": {
      "filter": {
        "match": {
          "user": "kimchy"
        }
      }
    },
    "alias3": {
      "routing": "1"
    },
    "alias4": {
      "index_routing": "2",
      "search_routing": "1,2"
    }
  }
}
--------------------------------------------------
// CONSOLE
////

[source,js]
--------------------------------------------------
GET /_cat/aliases?v
--------------------------------------------------
// CONSOLE
// TEST[continued]

Might respond with:

[source,txt]
--------------------------------------------------
alias  index filter routing.index routing.search
alias1 test1 -      -            -
alias2 test1 *      -            -
alias3 test1 -      1            1
alias4 test1 -      2            1,2
--------------------------------------------------
// TESTRESPONSE[s/[*]/[*]/ _cat]

The output shows that `alias2` 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.`

CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717 2016-10-06 13:31:18 -04:00			`////`
			`Hidden setup for example:`
			`[source,js]`
			`--------------------------------------------------`
			`PUT test1`
			`{`
			`"aliases": {`
			`"alias1": {},`
			`"alias2": {`
			`"filter": {`
			`"match": {`
			`"user": "kimchy"`
			`}`
			`}`
			`},`
			`"alias3": {`
			`"routing": "1"`
			`},`
			`"alias4": {`
			`"index_routing": "2",`
			`"search_routing": "1,2"`
			`}`
			`}`
			`}`
			`--------------------------------------------------`
			`// CONSOLE`
			`////`

			`[source,js]`
			`--------------------------------------------------`
			`GET /_cat/aliases?v`
			`--------------------------------------------------`
			`// CONSOLE`
			`// TEST[continued]`

			`Might respond with:`

Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160 2016-10-25 10:56:30 -04:00			`[source,txt]`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00			`--------------------------------------------------`
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			`alias1 test1 - - -`
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717 2016-10-06 13:31:18 -04:00			`alias2 test1 * - -`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00			`alias3 test1 - 1 1`
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717 2016-10-06 13:31:18 -04:00			`alias4 test1 - 2 1,2`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00			`--------------------------------------------------`
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717 2016-10-06 13:31:18 -04:00			`// TESTRESPONSE[s/[]/[]/ _cat]`
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class. 2014-01-20 03:23:00 -05:00
[DOCS] Fixed various typos in the 'cat APIs' section (#23216) 2017-02-16 14:41:42 -05:00			The output shows that `alias2` 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`.