7
7
Returns information about currently configured aliases to indices, including
8
8
filter and routing information.
9
9
10
-
11
10
[[cat-alias-api-request]]
12
11
==== {api-request-title}
13
12
14
- `GET / _cat/aliases/<alias>`
13
+ `GET _cat/aliases/<alias>`
15
14
16
- `GET / _cat/aliases`
15
+ `GET _cat/aliases`
17
16
18
17
[[cat-alias-api-prereqs]]
19
18
==== {api-prereq-title}
@@ -26,9 +25,9 @@ for any alias you retrieve.
26
25
==== {api-path-parms-title}
27
26
28
27
`<alias>`::
29
- (Optional, string)
30
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias]
31
-
28
+ (Optional, string) Comma-separated list of aliases to retrieve. Supports
29
+ wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or
30
+ `_all`.
32
31
33
32
[[cat-alias-api-query-params]]
34
33
==== {api-query-parms-title}
@@ -47,14 +46,13 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
47
46
48
47
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
49
48
50
-
51
49
[[cat-alias-api-example]]
52
50
==== {api-examples-title}
53
51
54
52
////
55
53
Hidden setup for example:
56
- [source,console]
57
- --------------------------------------------------
54
+ [source,console,id=cat-aliases-example ]
55
+ ----
58
56
PUT test1
59
57
{
60
58
"aliases": {
@@ -75,25 +73,25 @@ PUT test1
75
73
}
76
74
}
77
75
}
78
- --------------------------------------------------
76
+ ----
79
77
////
80
78
81
79
[source,console]
82
- --------------------------------------------------
83
- GET / _cat/aliases?v=true
84
- --------------------------------------------------
80
+ ----
81
+ GET _cat/aliases?v=true
82
+ ----
85
83
// TEST[continued]
86
84
87
85
The API returns the following response:
88
86
89
87
[source,txt]
90
- --------------------------------------------------
88
+ ----
91
89
alias index filter routing.index routing.search is_write_index
92
90
alias1 test1 - - - -
93
91
alias2 test1 * - - -
94
92
alias3 test1 - 1 1 -
95
93
alias4 test1 - 2 1,2 -
96
- --------------------------------------------------
94
+ ----
97
95
// TESTRESPONSE[s/[*]/[*]/ non_json]
98
96
99
97
This response shows that `alias2` has configured a filter, and specific routing
0 commit comments