获取别名 API
编辑获取别名 API
编辑检索一个或多个别名的信息。
resp = client.indices.get_alias(
index="my-data-stream",
name="my-alias",
)
print(resp)
response = client.indices.get_alias( index: 'my-data-stream', name: 'my-alias' ) puts response
const response = await client.indices.getAlias({
index: "my-data-stream",
name: "my-alias",
});
console.log(response);
GET my-data-stream/_alias/my-alias
先决条件
编辑- 如果启用了 Elasticsearch 安全功能，则您必须拥有别名的
view_index_metadata或manage索引权限。如果您指定了目标，您还必须拥有目标的view_index_metadata或manage索引权限。
路径参数
编辑-
<别名> - （可选，字符串）要检索的别名，以逗号分隔的列表。支持通配符（
*）。要检索所有别名，请省略此参数或使用*或_all。 -
<目标> - （可选，字符串）用于限制请求的数据流或索引，以逗号分隔的列表。支持通配符（
*）。要定位所有数据流和索引，请省略此参数或使用*或_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，则包含<目标>中缺失的数据流或索引的请求将返回错误。默认为false。 -
local - （可选，布尔值）如果为
true，则该请求仅从本地节点检索信息。默认为false，这意味着信息是从主节点检索的。