别名存在 API
编辑别名存在 API
编辑检查别名是否存在。
resp = client.indices.exists_alias( name="my-alias", ) print(resp)
response = client.indices.exists_alias( name: 'my-alias' ) puts response
const response = await client.indices.existsAlias({ name: "my-alias", }); console.log(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
- 一个或多个指定的别名不存在。