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