mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-08 20:42:10 +00:00
fe8d702ca9
* add operation to titles to differentiate from the API group acronym Signed-off-by: alicejw <alicejw@amazon.com> * update frontmatter with new page title Signed-off-by: alicejw <alicejw@amazon.com> * for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713 Signed-off-by: alicejw <alicejw@amazon.com> * to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly Signed-off-by: alicejw <alicejw@amazon.com> * to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title Signed-off-by: alicejw <alicejw@amazon.com> Signed-off-by: alicejw <alicejw@amazon.com>
64 lines
1.7 KiB
Markdown
64 lines
1.7 KiB
Markdown
---
|
|
layout: default
|
|
title: CAT aliases
|
|
parent: CAT API
|
|
|
|
nav_order: 1
|
|
has_children: 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
|
|
|
|
```json
|
|
GET _cat/aliases?v
|
|
```
|
|
|
|
To limit the information to a specific alias, add the alias name after your query:
|
|
|
|
```json
|
|
GET _cat/aliases/<alias>?v
|
|
```
|
|
|
|
If you want to get information for more than one alias, separate the alias names with commas:
|
|
|
|
```json
|
|
GET _cat/aliases/alias1,alias2,alias3
|
|
```
|
|
|
|
## 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]({{site.url}}{{site.baseurl}}/api-reference/cat/index), 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:
|
|
|
|
```json
|
|
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]({{site.url}}{{site.baseurl}}/opensearch/index-alias).
|