CAT 别名
1.0 版引入
CAT 别名操作列出了别名到索引的映射,以及路由和筛选信息。
端点
GET /_cat/aliases
GET /_cat/aliases/{name}
查询参数
下表列出了可用的查询参数。所有查询参数都是可选的。
参数 | 数据类型 | 描述 | 默认值 |
---|---|---|---|
expand_wildcards | 列表或字符串 | 指定通配符表达式可匹配的索引类型。支持逗号分隔的值。 有效值为 - all :匹配任何索引,包括隐藏索引。- closed :匹配已关闭的非隐藏索引。- hidden :匹配隐藏索引。必须与 open、closed 或两者结合使用。- none :不接受通配符表达式。- open :匹配已打开的非隐藏索引。 | 不适用 |
format | 字符串 | Accept 标头的简短版本,例如 json 或 yaml 。 | 不适用 |
h | 列表 | 要显示的列名的逗号分隔列表。 | 不适用 |
help | 布尔型 | 返回帮助信息。 | false |
local | 布尔型 | 是否仅返回本地节点的信息,而不是来自集群管理器节点的信息。 | false |
s | 列表 | 用于排序的列名或列别名的逗号分隔列表。 | 不适用 |
v | 布尔型 | 启用详细模式,该模式显示列标题。 | false |
示例请求
GET _cat/aliases?v
要将信息限制到特定别名,请在查询后添加别名名称
GET _cat/aliases/<alias>?v
如果要获取多个别名的信息,请用逗号分隔别名名称
GET _cat/aliases/alias1,alias2,alias3
示例响应
以下响应显示 alias1
指向 movies
索引并已配置过滤器
alias | index | filter | routing.index | routing.search | is_write_index
alias1 | movies | * | - | - | -
.opensearch-dashboards | .opensearch-dashboards_1 | - | - | - | -
要了解有关索引别名的更多信息,请参阅索引别名。