ElasticSearch 基础教程
首页 死磕 Java 优质系列 Java 技术总览 Java 面试宝典 关于我

Elasticsearch7.x——Cat命令详解

转
 2024-03-13
©版权
原文作者：吴声子夜歌 原文地址： https://blog.csdn.net/cold___play/article/details/133824575

查看API

JSON格式非常适合计算机，虽然打印得很好，但用户试图在数 据中查找到关系时也会感到乏味。人类的眼睛，尤其是在看终端时， 需要的是紧凑和对齐的文本。/_cat旨在满足这一需求。

1、查看子目录

_cat/后不跟任何子节点，返回的结果是目录，也就是可用的 URL节点，这个功能是非常有用的，当忘记某个接口时可以先执行这 个接口。示例如下:

    get /_cat

返回结果就是所有可用的Cat API：

    /_cat/allocation
    /_cat/shards
    /_cat/shards/{index}
    /_cat/master
    /_cat/nodes
    /_cat/tasks
    /_cat/indices
    /_cat/indices/{index}
    /_cat/segments
    /_cat/segments/{index}
    /_cat/count
    /_cat/count/{index}
    /_cat/recovery
    /_cat/recovery/{index}
    /_cat/health
    /_cat/pending_tasks
    /_cat/aliases
    /_cat/aliases/{alias}
    /_cat/thread_pool
    /_cat/thread_pool/{thread_pools}
    /_cat/plugins
    /_cat/fielddata
    /_cat/fielddata/{fields}
    /_cat/nodeattrs
    /_cat/repositories
    /_cat/snapshots/{repository}
    /_cat/templates
    /_cat/transforms
    /_cat/transforms/{transform_id}

2、公共参数

可以多个参数一起使用，用&连接

    GET /_cat/indices?v&s=store.size:desc

2.1、Verbose

每个命令都接受一个查询字符串参数v来打开详细输出。例如:

    GET /_cat/master?v

返回：

    id                     host      ip        node
    Cc6ARDA6TY-poOdtxvsA6g 127.0.0.1 127.0.0.1 zhangchenglongdeMacBook-Pro.local

2.2、help

每个命令都接受一个查询字符串参数help，该参数将输出其可用 值。示例:

    GET /_cat/master?help

返回：

    id   |   | node id    
    host | h | host name  
    ip   |   | ip address 
    node | n | node name

2.3、h

每个命令都接受一个查询字符串参数h，该参数只强制显示这些 列。示例

    GET /_cat/nodes?h=ip,port,heapPercent,name

返回：

    127.0.0.1 9300 35 zhangchenglongdeMacBook-Pro.local

2.4、sort

指定输出的列进行排序，默认按照升序排序:

    GET /_cat/indices/?v&s=pri,rep:desc

返回：

    health status index                           uuid                   pri rep docs.count docs.deleted store.size pri.store.size
    yellow open   a                               G8WjS7PoQRG9kCQznaDmsg   1   1          1            0      3.4kb          3.4kb
    yellow open   recipes                         agtHN2npS2GE90N81xtjEA   1   1          9            0      4.8kb          4.8kb
    yellow open   b                               lnBia7kNQJOBAKvFLWefTg   1   1          1            0      3.6kb          3.6kb
    yellow open   log                             H3bResC1QyK-9hdZQ0gs0g   1   1          1            0      4.3kb          4.3kb
    yellow open   geo_shape

2.5、format

指定响应返回的数据格式：text（默认）,json,yaml,smile,cbor
（通过设置 Accept的HTTP头部的多媒体格式的优先级更高）

    GET /_cat/master?format=json

返回：

    [
      {
        "id" : "Cc6ARDA6TY-poOdtxvsA6g",
        "host" : "127.0.0.1",
        "ip" : "127.0.0.1",
        "node" : "zhangchenglongdeMacBook-Pro.local"
      }
    ]

3、常用接口

3.1、aliases——别名、过滤器、路由信息

显示别名,过滤器,路由信息：

    GET /_cat/aliases?v

202403132037260081.png

返回字段 原文 含义
alias aliasname 别名
index indexaliaspointsto 别名指向
filter filter 过滤器
routing.index indexrouting 索引路由
routing.search searchrouting 搜索路由
is_write_index writeindex 写索引

3.2、allocation——分片数量、占用空间

显示每个节点分片数量、占用空间

    GET /_cat/allocation?v

202403132037263992.png

返回字段 原文 含义
shards numberofshardsonnode 节点承载的分片数量
disk.indics diskusedbyESindices 索引占用的空间大小
disk.used disused(total,notjustES) 节点所在及其已使用的磁盘空间大小
disk.avail diskavailable 节点可用空间大小
disk.total totalcapacityofallvolumes 节点总空间大小
disk.percent percentdiskused 节点磁盘占用百分比
host hostofnode 节点host
ip ipofnoe 节点ip
node nameofnode 节点名称

3.3、count——文档数量

显示索引文档的数量

    GET /_cat/count?v

202403132037267513.png

返回字段 原文 含义
epoch secondssince1970-01-0100:00:00 自标准时间（1970-01-0100:00:00）以来的秒数
timestamp timeinHH:MM:SS 时分秒，utc时区
count thedocumentcount 文档总数

3.4、health——健康信息

查看集群健康状况

    GET /_cat/health?v

202403132037272354.png

返回字段 原文 含义
epoch secondssince1970-01-0100:00:00 自标准时间（1970-01-0100:00:00）以来的秒数
timestamp timeinHH:MM:SS 时分秒，utc时区
cluster clustername 集群名称
status healthstauts 集群状态
node.total totalnumberofnodes 节点总数
node.data numberofnodesthatcanstoredata 数据节点总数
shards totalnumberofshards 分片总数
pri numberofprimaryshards 主分片总数
relo numberofrelocatingnodes 复制节点总数
init numberofinitializingnodes 初始化节点总数
unassign numberofunassignedshards 未分配分片总数
pending_tasks numberofpendingtasks 待定任务总数
max_task_wait_time waittimeoflongesttaskpending 等待最长任务的等待时间
active_shards_percent activenumberofshardsinpercent 活动分片百分比

3.5、indices——索引信息

查看索引信息

    GET /_cat/indices?v

202403132037276065.png

返回字段 原文 含义
health currenthealthstatus 索引健康状态
status open/closestatus 索引的开启状态
index indexname 索引名称
uuid indexuuid 索引uuid
pri numberofprimaryshards 索引主分片数
rep numberofreplicashards 所以副本分片数量
docs.count availabledocs 索引中文档总数
docs.deleted deleteddocs 索引中删除状态的文档
store.size storesizeofprimaries&replicas 主分片+副本分片的大小
pri.store.size storesizeofprimaries 主分片的大小

3.6、master——master节点信息

显示master节点信息

    GET /_cat/master?v

202403132037282226.png

返回字段 原文 含义
id nodeid 节点id
host hostname host
ip ipaddress ip
node nodename 节点名称

3.7、nodeattrs——节点属性

显示node节点属性

    GET /_cat/nodeattrs?v

202403132037286397.png

返回字段 原文 含义
node nodename 节点名称
host hostname host
ip ipaddress ip
attr arrributedescription 属性描述
value attributevalue 属性值

3.8、nodes——节点信息

显示node节点信息

    GET /_cat/nodes?v

202403132037290668.png

返回字段 原文 含义
ip ip ip
hap.percent usedheap 堆内存占用百分比
ram.percent usedmachinememoryratio 内存占用百分比
cpu recentcpu CPU占用百分比
load_1m 1mloadavg 1分钟的系统负载
load_5m 5mloadavg 5分钟的系统负载
load_15m 15mloadavg 15分钟的系统负载
node.role m:mastereligiblenode,d:datanode,i:ingestnode,-:coordinatingnodeonly node节点的角色
master *:currentmaster 是否是master节点
name nodename 节点名称

3.9、pending_tasks——等待任务

显示正在等待的任务

    GET /_cat/pending_tasks?v

202403132037294489.png

返回字段 原文 含义
insertOrder taskinsertionorder 任务插入顺序
timeInQueue howlongtaskhasbeeninqueue 任务排队了多长时间
priority taskpriority 任务优先级
source tasksource 任务源

3.10、plugins——插件信息

显示节点上的插件

    GET /_cat/plugins?v

2024031320372977910.png

返回字段 原文 含义
name nodename 节点名称
component component 插件名称
version componentversion 插件版本

3.11、recovery——索引碎片恢复视图

显示正在进行和先前完成的索引碎片恢复的视图

    GET /_cat/recovery?format=json

返回：

    [
      {
        "index" : "log",
        "shard" : "0",
        "time" : "22ms",
        "type" : "existing_store",
        "stage" : "done",
        "source_host" : "n/a",
        "source_node" : "n/a",
        "target_host" : "127.0.0.1",
        "target_node" : "zhangchenglongdeMacBook-Pro.local",
        "repository" : "n/a",
        "snapshot" : "n/a",
        "files" : "0",
        "files_recovered" : "0",
        "files_percent" : "100.0%",
        "files_total" : "4",
        "bytes" : "0",
        "bytes_recovered" : "0",
        "bytes_percent" : "100.0%",
        "bytes_total" : "4498",
        "translog_ops" : "0",
        "translog_ops_recovered" : "0",
        "translog_ops_percent" : "100.0%"
      },
      ...
    ]
返回字段 原文 含义
index indexname 索引名称
shard shardname 分片名称
time recoverytime 恢复时间
type recoverytype 恢复类型
stage recoverystage 恢复阶段
source_host sourcehost 源主机
source_node sourcenodename 源节点名称
target_host targethost 目标主机
target_node targetnodename 目标节点名称
repository repository 仓库
snapshot snpshot 快照
files numberoffilestorecover 要恢复的文件数
files_recovered filesrecovered 已恢复的文件数
files_pervent perventoffilesrecoverd 恢复文件百分比
files_total totalnumberoffiles 文件总数
bytes numberofbytestorecover 要恢复的字节数
bytes_recovered bytesrecovered 已恢复的字节数
bytes_percent percentofbytesrecovered 恢复字节百分比
bytes_total totalnumberofbytes 字节总数
translog_ops numberoftranslogopstorecover 要恢复的translog操作数
translog_ops_recovered translogopsrecovered 已恢复的translog操作数
translog_ops_percent percentoftransogopsrecovered 恢复的translog操作的百分比

3.12、segments——分段信息

显示分片中的分段信息

    GET /_cat/segments?v

2024031320373010711.png

返回字段 原文 含义
index indexname 索引名称
shard shardname 分片名称
prirep primaryorreplica 主分片还是副本分片
ip ipofnodewhereitlives 所在节点ip
segment segmentname segments段名
generation segmentgeneration 分段生成
docs.count numberofdocsinsegment 段中的文档数
docs.deleted numberofdeleteddocsinsegment 段中删除的文档数
size segmentsizeinbytes 段大小，以字节为单位
size.memory segmentmemoryinbytes 段内存大小，以字节为单位
committed issegmentcommitted 段是否已提交
searchable issegmentsearched 段是否可搜索
version version 版本
compound issegmentcompound compound模式

3.13、shards——分片信息

显示索引分片信息

    GET /_cat/shards?v

2024031320373075112.png

返回字段 原文 含义
index indexname 索引名称
shard shardname 分片序号
prirep primaryorreplica 分片类型，p表示是主分片，r表示是复制分片
state shardstate 分片状态
docs numberofdocsinshard 该分片存放的文档数量
store storesizeofshard(howmuchdiskituses) 该分片占用的存储空间大小
ip ipofnodewhereitlives 该分片所在服务器ip
node nameofnodewhereit 该分片所在的节点名称

3.14、thread_pool——线程池信息

显示线程池信息

    GET /_cat/thread_pool?v

2024031320373161713.png

返回字段 原文 含义
node_name nodename 节点名称
name threadpoolname 线程池名称
active numberofactivetreads 活跃线程数
queue numberoftaskscurrentlyinqueue 当前队列中的任务数
rejected numberofrejectedtasks 被拒绝的任务数

3.15、templates——模板信息

显示模板信息

    GET /_cat/templates?v

2024031320373217314.png

返回字段 原文 含义
name templatename 模板名称
index_patterns templateindexpatterns 模板匹配规则
order templateapplicationordernumber 模板优先级
version version 模板版本
阅读全文
文章标签： ElasticSearch 教程ElasticSearch