CAT 索引
1.0 版引入
CAT 索引操作列出与索引相关的信息,即它们正在使用的磁盘空间量、拥有的分片数量、其健康状态等等。
端点
GET /_cat/indices
GET /_cat/indices/{index}
查询参数
下表列出了可用的查询参数。所有查询参数都是可选的。
参数 | 数据类型 | 描述 | 默认值 |
---|---|---|---|
bytes(字节) | 字符串 | 用于显示字节值的单位。 有效值包括: b 、kb 、k 、mb 、m 、gb 、g 、tb 、t 、pb 和 p 。 | 不适用 |
cluster_manager_timeout | 字符串 | 允许与集群管理器节点建立连接的时间量。 | 不适用 |
expand_wildcards | 列表或字符串 | 指定通配符表达式可匹配的索引类型。支持逗号分隔的值。 有效值为 - all :匹配任何索引,包括隐藏索引。- closed :匹配已关闭的非隐藏索引。- hidden :匹配隐藏索引。必须与 open、closed 或两者结合使用。- none :不接受通配符表达式。- open :匹配已打开的非隐藏索引。 | 不适用 |
format | 字符串 | Accept 标头的简短版本,例如 json 或 yaml 。 | 不适用 |
h | 列表 | 要显示的列名的逗号分隔列表。 | 不适用 |
health | 字符串 | 根据索引的健康状态限制索引。支持的值有 green (绿色)、yellow (黄色)和 red (红色)。有效值包括: green 、GREEN 、yellow 、YELLOW 、red 和 RED 。 | 不适用 |
help | 布尔型 | 返回帮助信息。 | false |
include_unloaded_segments | 布尔型 | 是否包含未加载到内存中的段的信息。 | false |
local | 布尔型 | 返回本地信息,但不从集群管理器节点检索状态。 | false |
pri | 布尔型 | 当为 true 时,仅返回主分片的信息。 | false |
s | 列表 | 用于排序的列名或列别名的逗号分隔列表。 | 不适用 |
time | 字符串 | 指定时间单位。 有效值包括: nanos 、micros 、ms 、s 、m 、h 和 d 。 | 不适用 |
v | 布尔型 | 启用详细模式,该模式显示列标题。 | false |
示例请求
GET _cat/indices?v
要将信息限制到特定索引,请在查询后添加索引名称。
GET _cat/indices/<index>?v
如果要获取多个索引的信息,请用逗号分隔索引
GET _cat/indices/index1,index2,index3
示例响应
health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
green | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb
限制响应大小
要限制返回的索引数量,请配置 cat.indices.response.limit.number_of_indices
设置。有关更多信息,请参阅集群级 CAT 响应限制设置。