|
@@ -1,8 +1,41 @@
|
|
|
[[cat-alias]]
|
|
|
=== cat aliases
|
|
|
|
|
|
-`aliases` shows information about currently configured aliases to indices
|
|
|
-including filter and routing infos.
|
|
|
+Returns information about currently configured aliases to indices, including
|
|
|
+filter and routing information.
|
|
|
+
|
|
|
+
|
|
|
+[[cat-alias-api-request]]
|
|
|
+==== {api-request-title}
|
|
|
+
|
|
|
+`GET /_cat/aliases/{name}`
|
|
|
+
|
|
|
+[[cat-alias-api-path-params]]
|
|
|
+==== {api-path-parms-title}
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=name]
|
|
|
+
|
|
|
+
|
|
|
+[[cat-alias-api-query-params]]
|
|
|
+==== {api-query-parms-title}
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
|
|
+
|
|
|
+include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
|
|
|
+
|
|
|
+
|
|
|
+[[cat-alias-api-example]]
|
|
|
+==== {api-examples-title}
|
|
|
|
|
|
////
|
|
|
Hidden setup for example:
|
|
@@ -39,7 +72,7 @@ GET /_cat/aliases?v
|
|
|
// CONSOLE
|
|
|
// TEST[continued]
|
|
|
|
|
|
-Might respond with:
|
|
|
+The API returns the following response:
|
|
|
|
|
|
[source,txt]
|
|
|
--------------------------------------------------
|
|
@@ -51,7 +84,7 @@ alias4 test1 - 2 1,2
|
|
|
--------------------------------------------------
|
|
|
// TESTRESPONSE[s/[*]/[*]/ non_json]
|
|
|
|
|
|
-The output shows that `alias2` has configured a filter, and specific routing
|
|
|
+This response shows that `alias2` has configured a filter, and specific routing
|
|
|
configurations in `alias3` and `alias4`.
|
|
|
|
|
|
If you only want to get information about specific aliases, you can specify
|