cat 别名 API
编辑cat 别名 API
编辑cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用别名 API。
检索集群的索引别名，包括过滤器和路由信息。该 API 不返回数据流别名。
路径参数
编辑-
<alias> - （可选，字符串）要检索的别名的逗号分隔列表。支持通配符 (
*)。要检索所有别名，请省略此参数或使用*或_all。
查询参数
编辑-
format - （可选，字符串）HTTP accept header的简短版本。有效值包括 JSON、YAML 等。
-
h - （可选，字符串）要显示的列名的逗号分隔列表。
-
help - （可选，布尔值）如果为
true，则响应包括帮助信息。默认为false。 -
local - （可选，布尔值）如果为
true，则请求仅从本地节点检索信息。默认为false，这意味着从主节点检索信息。 -
s - （可选，字符串）用于对响应进行排序的列名或列别名的逗号分隔列表。
-
v - （可选，布尔值）如果为
true，则响应包括列标题。默认为false。 -
expand_wildcards -
（可选，字符串）通配符模式可以匹配的索引类型。如果请求可以定向到数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持逗号分隔的值，例如
open,hidden。有效值包括：-
all - 匹配任何数据流或索引，包括隐藏的数据流和索引。
-
open - 匹配打开的、非隐藏的索引。也匹配任何非隐藏的数据流。
-
closed - 匹配关闭的、非隐藏的索引。也匹配任何非隐藏的数据流。数据流无法关闭。
-
hidden - 匹配隐藏的数据流和隐藏的索引。必须与
open、closed或两者结合使用。 -
none - 不接受通配符模式。
-
示例
编辑resp = client.cat.aliases(
v=True,
)
print(resp)
response = client.cat.aliases( v: true ) puts response
const response = await client.cat.aliases({
v: "true",
});
console.log(response);
GET _cat/aliases?v=true
API 返回以下响应
alias index filter routing.index routing.search is_write_index alias1 test1 - - - - alias2 test1 * - - - alias3 test1 - 1 1 - alias4 test1 - 2 1,2 -
此响应表明 alias2 已配置过滤器，并且在 alias3 和 alias4 中配置了特定的路由配置。
如果只想获取有关特定别名的信息，可以在 URL 参数中以逗号分隔的格式指定别名，例如，/_cat/aliases/alias1,alias2。