1.8 KiB
1.8 KiB
layout | title | parent | nav_order | has_children |
---|---|---|---|---|
default | CAT aliases | CAT API | 1 | false |
CAT aliases
Introduced 1.0 {: .label .label-purple }
The CAT aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
Example
GET _cat/aliases?v
{% include copy-curl.html %}
To limit the information to a specific alias, add the alias name after your query:
GET _cat/aliases/<alias>?v
{% include copy-curl.html %}
If you want to get information for more than one alias, separate the alias names with commas:
GET _cat/aliases/alias1,alias2,alias3
{% include copy-curl.html %}
Path and HTTP methods
GET _cat/aliases/<alias>
GET _cat/aliases
URL parameters
All CAT aliases URL parameters are optional.
In addition to the common URL parameters, you can specify the following parameters:
Parameter | Type | Description |
---|---|---|
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false. |
expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are all , open , closed , hidden , and none . Default is open . |
Response
The following response shows that alias1
refers to a movies
index and has a configured filter:
alias | index | filter | routing.index | routing.search | is_write_index
alias1 | movies | * | - | - | -
.opensearch-dashboards | .opensearch-dashboards_1 | - | - | - | -
To learn more about index aliases, see Index aliases.