› › ›

cat 别名 API

编辑

cat 别名 API编辑

cat API 仅用于使用命令行或 Kibana 控制台的人类使用。它们不适用于应用程序。对于应用程序使用，请使用别名 API。

检索集群的索引别名，包括过滤器和路由信息。该 API 不返回数据流别名。

请求编辑

GET _cat/aliases/<alias>

GET _cat/aliases

先决条件编辑

如果启用了 Elasticsearch 安全功能，则您必须对要检索的任何别名具有 view_index_metadata 或 manage 索引权限。

路径参数编辑

<alias>: (可选，字符串) 要检索的别名列表，用逗号分隔。支持通配符 (*)。要检索所有别名，请省略此参数或使用 * 或 _all。

查询参数编辑

format

(可选，字符串) HTTP 接受标头的简短版本。有效值包括 JSON、YAML 等。

h

(可选，字符串) 要显示的列名列表，用逗号分隔。

help

(可选，布尔值) 如果为 true，则响应包含帮助信息。默认为 false。

local

(可选，布尔值) 如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着信息是从主节点检索的。

s

(可选，字符串) 用于对响应进行排序的列名或列别名列表，用逗号分隔。

v

(可选，布尔值) 如果为 true，则响应包含列标题。默认为 false。

expand_wildcards

(可选，字符串) 通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数决定通配符表达式是否匹配隐藏数据流。支持用逗号分隔的值，例如 open,hidden。有效值为

all: 匹配任何数据流或索引，包括隐藏的数据流或索引。
open: 匹配打开的、非隐藏的索引。也匹配任何非隐藏的数据流。
closed: 匹配关闭的、非隐藏的索引。也匹配任何非隐藏的数据流。数据流不能关闭。
hidden: 匹配隐藏的数据流和隐藏的索引。必须与 open、closed 或两者结合使用。
none: 不接受通配符模式。

示例编辑

response = client.cat.aliases(
  v: true
)
puts 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。

« 简洁对齐文本 (CAT) API cat 分配 API »