Elasticsearch核心技能：cat API全面详解（作用+语法+常用命令+实战流程图）
Elasticsearch核心技能：cat API全面详解（作用+语法+常用命令+实战流程图）
- 一、前言：为什么Elasticsearch需要cat API？
- 二、Elasticsearch cat API：核心定义与作用
- 2.1 基础定义
- 2.2 核心作用（核心价值）
- 三、Elasticsearch cat API：工作原理流程图
- 四、Elasticsearch cat API：基础语法规范
- 4.1 通用请求格式
- 4.2 核心参数（必掌握）
- 4.3 基础调用示例（查看所有cat API列表）
- 五、Elasticsearch cat API：高频使用命令（带实战示例）
- 5.1 集群健康状态类
- 1. 查看集群整体健康状态（最重要）
- 2. 查看集群节点信息
- 5.2 索引管理类
- 1. 查看所有索引信息（最常用）
- 2. 按索引大小排序（查看大索引）
- 5.3 分片与副本类
- 1. 查看分片分配详情（排查分片未分配）
- 2. 查看未分配分片
- 5.4 磁盘与资源监控类
- 1. 查看节点磁盘使用情况
- 5.5 线程池与性能类
- 1. 查看线程池状态（排查性能瓶颈）
- 六、Elasticsearch cat API：高级用法（自定义输出）
- 6.1 自定义显示列（h参数）
- 6.2 排序输出（s参数）
- 6.3 JSON格式输出
- 七、cat API vs 普通JSON API：核心区别
- 八、总结：cat API使用核心要点
- 九、文末总结
- 总结
🌺The Begin🌺点点关注，收藏不迷路🌺 |
一、前言：为什么Elasticsearch需要cat API？
在Elasticsearch（ES）日常运维、故障排查、性能调优过程中，我们经常需要快速查看集群状态、节点信息、索引分片、磁盘占用、线程池等核心数据。
ES官方提供的cat API就是为了解决这个问题而生——它是轻量级、人类可读、命令行友好的实时监控工具，专门用于以简洁的文本格式展示ES集群的各类运行数据，替代了复杂的JSON格式输出，让运维人员一眼就能看懂集群状态。
本文将从核心作用、基础语法、工作流程、常用命令、实战示例全方位讲解cat API，帮你快速掌握ES运维必备技能。
二、Elasticsearch cat API：核心定义与作用
2.1 基础定义
cat API是Elasticsearch内置的RESTful API集合，名称中的cat取自Linux系统的cat命令（查看文本内容），核心设计理念是将ES的复杂JSON数据，转化为简洁、对齐、易读的文本表格，适配终端/命令行查看场景。
2.2 核心作用（核心价值）
- 实时监控集群状态：快速查看集群健康值、节点存活状态、分片分布，第一时间发现集群异常
- 简化数据查看：摒弃冗余JSON格式，输出纯文本表格，无需解析即可读取关键信息
- 运维故障排查：定位分片未分配、节点宕机、索引占用过高、磁盘满等问题
- 性能调优参考：查看线程池、索引读写、内存使用、分片负载，为调优提供数据支撑
- 轻量级无侵入：无需安装插件、不占用集群资源，直接通过HTTP请求调用
- 兼容所有工具：支持curl、Postman、Kibana Dev Tools等所有HTTP客户端
三、Elasticsearch cat API：工作原理流程图
cat API的执行流程非常简洁，无复杂依赖，直接与ES集群交互，流程图如下：
流程解读：
- 运维人员通过curl/Dev Tools发送指定的cat API请求
- ES集群实时拉取对应模块（节点/索引/分片）的运行数据
- 后台自动将原生JSON数据转换为对齐的文本表格
- 快速返回结果，无任何数据持久化，轻量高效
四、Elasticsearch cat API：基础语法规范
4.1 通用请求格式
GET /_cat/<API名称>?<参数>4.2 核心参数（必掌握）
v：verbose，显示列名（最常用，不加看不到表头）h：指定需要展示的列，自定义输出内容format：指定输出格式（json/text/yaml）s：对结果进行排序（如s=disk.used:desc按磁盘占用降序）help：查看当前API支持的所有列和说明
4.3 基础调用示例（查看所有cat API列表）
# 查看ES支持的所有cat API GET /_cat五、Elasticsearch cat API：高频使用命令（带实战示例）
这部分是运维最常用的cat API命令，按使用场景分类，直接复制即可使用。
5.1 集群健康状态类
1. 查看集群整体健康状态（最重要）
GET /_cat/health?v关键字段：
epoch：时间戳cluster：集群名称status：集群状态（green=健康，yellow=副本异常，red=主分片异常）node.total：总节点数shards：总分片数
2. 查看集群节点信息
GET /_cat/nodes?v关键字段：ip、heap.percent（堆内存占用）、ram.percent（物理内存占用）、cpu（CPU使用率）、node.role（节点角色）
5.2 索引管理类
1. 查看所有索引信息（最常用）
GET /_cat/indices?v关键字段：health（索引健康值）、index（索引名）、docs.count（文档数）、store.size（磁盘占用）
2. 按索引大小排序（查看大索引）
GET /_cat/indices?v&s=store.size:desc5.3 分片与副本类
1. 查看分片分配详情（排查分片未分配）
GET /_cat/shards?v关键字段：index、shard（分片号）、prirep（主分片/副本）、state（状态）、ip（节点IP）
2. 查看未分配分片
GET /_cat/shards?v|grep UNASSIGNED5.4 磁盘与资源监控类
1. 查看节点磁盘使用情况
GET /_cat/allocation?v关键字段：shards（分片数）、disk.used（磁盘已用）、disk.avail（磁盘可用）
5.5 线程池与性能类
1. 查看线程池状态（排查性能瓶颈）
GET /_cat/thread_pool?v六、Elasticsearch cat API：高级用法（自定义输出）
6.1 自定义显示列（h参数）
只查看索引名、文档数、磁盘占用：
GET /_cat/indices?v&h=index,docs.count,store.size6.2 排序输出（s参数）
按节点CPU使用率降序排序：
GET /_cat/nodes?v&s=cpu:desc6.3 JSON格式输出
GET /_cat/indices?format=json七、cat API vs 普通JSON API：核心区别
| 对比维度 | cat API | 普通JSON API |
|---|---|---|
| 输出格式 | 人类可读文本表格 | 结构化JSON |
| 可读性 | 极高，终端直接查看 | 低，需要解析 |
| 使用场景 | 日常运维、快速排查 | 程序调用、数据解析 |
| 性能 | 轻量级，响应极快 | 数据量大，响应稍慢 |
| 学习成本 | 极低 | 较高 |
八、总结：cat API使用核心要点
- 核心定位：ES运维首选监控工具，专门用于快速查看集群运行状态
- 必加参数：
v（显示列名），90%的命令都需要加 - 核心场景：集群健康检查、索引管理、分片故障排查、资源监控
- 优势：轻量、无侵入、易读、高效，无需任何插件
九、文末总结
Elasticsearch的cat API是运维人员必须掌握的基础技能，它摒弃了复杂的JSON格式，用最简单的文本表格展示集群核心数据，无论是日常巡检、故障定位还是性能调优，都能大幅提升工作效率。
建议收藏本文，在ES运维过程中直接对照使用，快速解决各类集群问题！
总结
- cat API核心作用：将ES集群数据转为人类可读文本，用于监控、排查、调优，轻量无侵入
- 工作流程：发起请求→采集数据→格式转换→返回文本→直观查看
- 必备参数：
v（显示表头）、h（自定义列）、s（排序） - 高频命令：
_cat/health（集群健康）、_cat/nodes（节点）、_cat/indices（索引）、_cat/shards（分片） - 核心优势：可读性拉满、运维效率极高、适配所有ES版本
🌺The End🌺点点关注，收藏不迷路🌺 |