Apache RocketMQ官方文档中文精简版-CLI管理工具

最新推荐文章于 2026-05-23 13:15:26 发布

翻译最新推荐文章于 2026-05-23 13:15:26 发布 · 782 阅读

1 ·

本内容遵循CC 4.0 BY-SA版权协议

原文链接：http://rocketmq.apache.org/docs/cli-admin-tool/

收录于

Apache RocketMQ提供了一个命令行接口（CLI）工具，方便查询、管理和诊断。在使用前，需了解Quick Start和Core Concept。该工具包含在RocketMQ的二进制包或源代码中，可在*nix环境下运行。通过执行`mqadmin help <command>`可获取具体命令的帮助信息。

CLI 管理工具

RocketMQ提供了一个CLI管理工具，用于查询、管理和诊断各种问题。

先决条件

确保您已经浏览了Quick Start和Core Concept 部分。

如何获取

管理工具随Rocketmq一起提供。无论您是下载一个预构建的二进制版本，还是自己从源代码进行构建，您都拥有这个随包的工具。如果您想查看源代码，请参阅rocketmq-tools module

如何使用

管理工具对用户非常友好。这里，出于演示目的，假设为*nix环境。

将目录更改为${PACKAGE}/bin，命令bash mqadmin，您应该看到以下帮助菜单。

最常用的mqadmin命令有:
   updateTopic          更新或创建主题
   deleteTopic          从broker和NameServer删除主题
   updateSubGroup       更新或创建订阅组
   deleteSubGroup       从broker删除订阅组
   updateBrokerConfig   更新broker的配置
   updateTopicPerm      更新主题权限
   topicRoute           测试主题路由信息
   topicStatus          测试主题状态信息
   topicClusterList     获取主题的集群信息
   brokerStatus         获取broker的运行时状态数据
   queryMsgById         根据Id查询消息
   queryMsgByKey        根据Key查询消息
   queryMsgByUniqueKey  根据Unique Key查询消息
   queryMsgByOffset     根据Offset查询消息
   queryMsgByUniqueKey  根据Unique Key查询消息
   printMsg             打印消息详情
   sendMsgStatus        发送消息到broker.
   brokerConsumeStats   获取broker的消费状态数据
   producerConnection   查询生产者的socket连接，和client版本
   consumerConnection   查询消费者的socket连接, client版本和订阅情况
   consumerProgress     查询消费者的进度，速度
   consumerStatus       查询消费者的内部数据结构
   cloneGroupOffset     从另外的group复制offset
   clusterList          列出所有集群
   topicList            从name server获取所有的主题列表
   updateKvConfig       创建或更新KV配置
   deleteKvConfig       删除KV配置
   wipeWritePerm        去掉name server中所有broker的写入权限
   resetOffsetByTime    根据timestamp，重置消费者的偏移量(不需要重启client).
   updateOrderConf      创建、更新或删除排序配置
   cleanExpiredCQ       清空broker上过期的消费队列
   cleanUnusedTopic     清空broker上未使用的主题
   startMonitoring      启动监听器
   statsAll             主题和消费者的tps吞吐量统计
   syncDocs             同步wiki和issue到github.com
   allocateMQ           划分MQ
   checkMsgSendRT       检查消息发送的响应时间
   clusterRT            列出所有集群消息发送的响应时间

See 'mqadmin help <command>' for more information on a specific command.

如您所见，最常用的命令附加简短的描述被罗列了出来。要获得每个命令的详细手册，可执行bash mqadmin help<command>。例如，命令bash mqadmin help clusterList将显示以下帮助文本：

usage: mqadmin clusterList [-h] [-i <arg>] [-m] [-n <arg>]
 -h,--help                Print help
 -i,--interval <arg>      specify intervals numbers, it is in seconds
 -m,--moreStats           Print more stats
 -n,--namesrvAddr <arg>   Name server address list, eg: 192.168.0.1:9876;192.168.0.2:9876

帮助文本列出了可能的选项和每个选项的解释。