70 lines
4.1 KiB
Plaintext
70 lines
4.1 KiB
Plaintext
[[reference-cat-aliases]]
|
||
|
||
////////
|
||
===========================================================================================================================
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||
|| ||
|
||
|| ||
|
||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||
|| You should update the script that does the generation, which can be found in: ||
|
||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||
|| ||
|
||
|| You can run the script with the following command: ||
|
||
|| npm run elasticsearch -- --version <version> ||
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
===========================================================================================================================
|
||
////////
|
||
++++
|
||
<style>
|
||
.lang-ts a.xref {
|
||
text-decoration: underline !important;
|
||
}
|
||
</style>
|
||
++++
|
||
|
||
[[client.cat.aliases]]
|
||
== client.cat.aliases
|
||
|
||
Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
|
||
|
||
{ref}/cat-alias.html[{es} documentation]
|
||
[discrete]
|
||
== Function signature
|
||
|
||
[source,ts]
|
||
----
|
||
(CatAliasesRequest, options?): Promise<CatAliasesResponse>
|
||
----
|
||
|
||
[discrete]
|
||
=== Request
|
||
|
||
[source,ts,subs=+macros]
|
||
----
|
||
interface CatAliasesRequest extends <<CatCatRequestBase>> {
|
||
name?: <<Names>>
|
||
expand_wildcards?: <<ExpandWildcards>>
|
||
}
|
||
|
||
----
|
||
|
||
[discrete]
|
||
=== Response
|
||
|
||
[source,ts,subs=+macros]
|
||
----
|
||
type CatAliasesResponse = CatAliasesAliasesRecord[]
|
||
|
||
----
|
||
|