File: fe_aliases.md

package info (click to toggle)
elasticsearch-curator 8.0.21-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,716 kB
  • sloc: python: 17,838; makefile: 159; sh: 156
file content (57 lines) | stat: -rw-r--r-- 1,446 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
mapped_pages:
  - https://www.elastic.co/guide/en/elasticsearch/client/curator/current/fe_aliases.html
---

# aliases [fe_aliases]

::::{admonition} Matching Indices and Aliases
:class: important

[Indices must be in all aliases to match](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/breaking-changes-5.5.html#breaking_55_rest_changes).

If a list of `aliases` is provided (instead of only one), indices must appear in *all* listed `aliases` or a 404 error will result, leading to no indices being matched. In older versions, if the index was associated with even one of the aliases in `aliases`, it would result in a match.

::::


::::{note}
This setting is used only when using the [alias](/reference/filtertype_alias.md) filter.
::::


The value of this setting must be a single alias name, or a list of alias names. This can be done in any of the ways YAML allows for lists or arrays.  Here are a few examples.

**Single**

```txt
filters:
- filtertype: alias
  aliases: my_alias
  exclude: False
```

**List**

* Flow style:

    ```txt
    filters:
    - filtertype: alias
      aliases: [ my_alias, another_alias ]
      exclude: False
    ```

* Block style:

    ```txt
    filters:
    - filtertype: alias
      aliases:
        - my_alias
        - another_alias
      exclude: False
    ```


There is no default value. This setting must be set by the user or an exception will be raised, and execution will halt.