https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-alias.html
_cat/aliases
检索集群的索引别名,包括过滤器和路由信息。API 不返回数据流别名。
GET _cat/aliases/<alias>
GET _cat/aliases
<alias>
(可选,字符串)要检索的以逗号分隔的别名列表。支持通配符 ( *)。要检索所有别名,请省略此参数或使用*or _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
不接受通配符模式。
例子
_cat/aliases?v=true
alias index filter routing.index routing.search is_write_index
alias1 test1 - - - -
alias2 test1 * - - -
alias3 test1 - 1 1 -
alias4 test1 - 2 1,2 -
_cat/count
文档计数仅包括活动文档,不包括尚未被合并过程删除的已删除文档。
GET /_cat/count/<target>
GET /_cat/count
<target>
(可选,字符串)用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 ( *)。要定位所有数据流和索引,请省略此参数或使用*or _all
查询参数
format
(可选,字符串) HTTP 接受标头的简短版本。有效值包括 JSON、YAML 等。
h
(可选,字符串)要显示的以逗号分隔的列名列表。
help
(可选,布尔值)如果true,则响应包括帮助信息。默认为false.
s
(可选,字符串)用于对响应进行排序的列名或列别名的逗号分隔列表。
v
(可选,布尔值)如果true,则响应包括列标题。默认为false.
例子
GET /_cat/count/my-index-000001?v=true
epoch timestamp count
1682041209 01:40:09 80
_cat/ml/datafeeds
返回有关数据馈送的配置和使用信息。
GET /_cat/ml/datafeeds/<feed_id>
GET /_cat/ml/datafeeds
<feed_id>
(可选,字符串)唯一标识数据馈送的数字字符串。此标识符可以包含小写字母数字字符(az 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。
查询参数略
例子
GET _cat/ml/datafeeds?v=true
/_cat/fielddata
返回集群中每个数据节点上字段数据缓存当前使用的堆内存量
GET /_cat/fielddata/<field>
GET /_cat/fielddata
路径参数编辑
<field>
(可选,字符串)用于限制返回信息的逗号分隔字段列表。
查询参数
bytes
(可选,字节大小单位)用于显示字节值的单位。
format
(可选,字符串) HTTP 接受标头的简短版本。有效值包括 JSON、YAML 等。
h
(可选,字符串)要显示的以逗号分隔的列名列表。
help
(可选,布尔值)如果true,则响应包括帮助信息。默认为false.
s
(可选,字符串)用于对响应进行排序的列名或列别名的逗号分隔列表。
v
(可选,布尔值)如果true,则响应包括列标题。默认为false.
例子
GET /_cat/fielddata?v=true&fields=body
_cat/health
返回集群的健康状态,类似于集群健康API。
GET /_cat/health
例子
GET /_cat/health?v=true
/_cat/indices
返回有关集群中索引的高级信息,包括数据流的支持索引
使用 cat indices API 获取集群中每个索引的以下信息:
- 分片数
- 文档计数
- 删除的文档数
- 所有分片的总存储大小,包括分片副本
/_cat/indices
例子
GET /_cat/indices/my-index-*?v=true&s=index
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size
green open test_index Baf6kb9VQW6XwYX_5hcpmQ 3 0 80 14 302.7kb 302.7kb
/_cat/master
返回主节点信息,包括ID、绑定的IP地址和名称。
GET /_cat/master
例子
GET /_cat/master?v=true
/_cat/nodeattrs
返回有关自定义节点属性的信息
GET /_cat/nodeattrs
例子
GET /_cat/nodeattrs?v=true
/_cat/nodes
返回有关集群节点的信息。
GET /_cat/nodes
例子
GET /_cat/nodes?v=true
/_cat/plugins
返回在集群的每个节点上运行的插件列表。
GET /_cat/plugins
例子
GET /_cat/plugins?v=true&s=component&h=name,component,version,description
/_cat/recovery
返回有关正在进行和已完成的分片恢复的信息,类似于索引恢复API。
对于数据流,API 返回有关流的支持索引的信息。
GET /_cat/recovery/<target>
GET /_cat/recovery
例子
GET _cat/recovery?v=true
/_cat/segments
返回有关索引分片中Lucene段的低级信息 ,类似于索引段 API。
对于数据流,API 返回有关流的支持索引的信息
GET /_cat/segments/<target>
GET /_cat/segments
例子
GET /_cat/segments?v=true
index shard prirep ip segment generation docs.count docs.deleted size size.memory committed searchable version compound
test 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.5.0 true
test1 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.5.0 true
/_cat/shards
该
shards
命令是哪些节点包含哪些分片的详细视图。它会告诉您它是主节点还是副本节点、文档数量、它在磁盘上占用的字节数以及它所在的节点。对于数据流,API 返回有关流的支持索引的信息。
GET /_cat/shards/<target>
GET /_cat/shards
/_cat/templates
GET /_cat/templates/<template_name>
GET /_cat/templates
例子
GET _cat/templates/my-template-test?v=true&s=name