别名存在 API
编辑别名存在 API编辑
检查 别名 是否存在。
response = client.indices.exists_alias( name: 'my-alias' ) puts response
HEAD _alias/my-alias
先决条件编辑
- 如果启用了 Elasticsearch 安全功能,您必须对别名具有
view_index_metadata
或manage
索引权限。如果您指定了目标,您还必须对目标具有view_index_metadata
或manage
索引权限。
路径参数编辑
-
<alias>
- (可选,字符串) 要检查的别名列表,用逗号分隔。支持通配符 (
*
)。 -
<target>
- (可选,字符串) 用逗号分隔的数据流或索引列表,用于限制请求。支持通配符 (
*
)。要针对所有数据流和索引,请省略此参数或使用*
或_all
。
查询参数编辑
-
expand_wildcards
-
(可选,字符串) 通配符模式可以匹配的索引类型。如果请求可以针对数据流,则此参数决定通配符表达式是否匹配隐藏数据流。支持用逗号分隔的值,例如
open,hidden
。有效值为-
all
- 匹配任何数据流或索引,包括 隐藏 的数据流或索引。
-
open
- 匹配打开的、非隐藏的索引。还匹配任何非隐藏的数据流。
-
closed
- 匹配关闭的、非隐藏的索引。还匹配任何非隐藏的数据流。数据流不能关闭。
-
hidden
- 匹配隐藏的数据流和隐藏的索引。必须与
open
、closed
或两者结合使用。 -
none
- 不接受通配符模式。
默认为
all
。 -
-
ignore_unavailable
- (可选,布尔值) 如果为
false
,则请求包含<target>
中缺少的数据流或索引将返回错误。默认为false
。 -
local
- (可选,布尔值) 如果为
true
,则请求仅从本地节点检索信息。默认为false
,这意味着信息是从主节点检索的。
响应代码编辑
-
200
- 所有指定的别名都存在。
-
404
- 一个或多个指定的别名不存在。