RocketMQ 学习之三 —— mqadmin

女爷i 2022-02-15 12:26 442阅读 0赞

# 1.1. 控制台使用 #

RocketMQ 提供有控制台及一系列控制台命令，用于管理员对主题，集群，broker 等信息的管理；

**登录控制台**

首先进入RocketMQ 工程，进入/RocketMQ/bin

在该目录下有个mqadmin 脚本

**查看帮助**

在mqadmin 下可以查看有哪些命令

sh mqadmin

**查看具体命令的使用**

sh mqadmin help 命令名称

例如，查看updateTopic 的使用

sh mqadmin help updateTopic

# 1.2. 详细命令 #

## 1.2.1. 创建Topic ##

指令

updateTopic

类路径

com.alibaba.rocketmq.tools.command.topic.UpdateTopicSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b </td> 
 <td> 如果-c为空，则必填 </td> 
 <td> broker&nbsp;地址，表示topic&nbsp;建在该broker </td> 
 </tr> 
 <tr> 
 <td> -c </td> 
 <td> 如果-b为空，则必填 </td> 
 <td> cluster&nbsp;名称，表示topic&nbsp;建在该集群（集群可通过clusterList&nbsp;查询） </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 <tr> 
 <td> -p </td> 
 <td> 否&nbsp; </td> 
 <td> 指定新topic&nbsp;的权限限制(&nbsp;W|R|WR&nbsp;) </td> 
 </tr> 
 <tr> 
 <td> -r&nbsp; </td> 
 <td> 否 </td> 
 <td> 可读队列数（默认为8） </td> 
 </tr> 
 <tr> 
 <td> -w </td> 
 <td> 否 </td> 
 <td> 可写队列数（默认为8） </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> opic&nbsp;名称（名称只能使用字符&nbsp;^[a-zA-Z0-9_-]+$&nbsp;） </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.2. 删除Topic ##

指令

deleteTopic

类路径

com.alibaba.rocketmq.tools.command.topic.DeleteTopicSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数&nbsp; </td> 
 <td> 是否必填 </td> 
 <td> &nbsp;说明 </td> 
 </tr> 
 <tr> 
 <td> -c </td> 
 <td> 是 </td> 
 <td> cluster&nbsp;名称，表示删除某集群下的某个topic&nbsp;（集群可通过clusterList&nbsp;查询） </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;… </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> topic&nbsp;名称（名称只能使用字符&nbsp;^[a-zA-Z0-9_-]+$&nbsp;） </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.3. 创建（修订）订阅组 ##

指令

updateSubGroup

类路径

com.alibaba.rocketmq.tools.command.consumer.UpdateSubGroupSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b </td> 
 <td> 如果&nbsp;–c&nbsp;为空，则必填 </td> 
 <td> broker&nbsp;地址，表示订阅组建在该broker </td> 
 </tr> 
 <tr> 
 <td> -c </td> 
 <td> 如果&nbsp;–b&nbsp;为空，则必填 </td> 
 <td> cluster名称，表示topic&nbsp;建在该集群（集群可通过clusterList查询） </td> 
 </tr> 
 <tr> 
 <td> -d </td> 
 <td> 否&nbsp; </td> 
 <td> 是否容许广播方式消费 </td> 
 </tr> 
 <tr> 
 <td> -g </td> 
 <td> 是&nbsp; </td> 
 <td> 订阅组名 </td> 
 </tr> 
 <tr> 
 <td> -i </td> 
 <td> 否 </td> 
 <td> 从哪个broker&nbsp;开始消费 </td> 
 </tr> 
 <tr> 
 <td> -m </td> 
 <td> 否 </td> 
 <td> 是否容许从队列的最小位置开始消费，默认会设置为false </td> 
 </tr> 
 <tr> 
 <td> -q </td> 
 <td> 否 </td> 
 <td> 消费失败的消息放到一个重试队列，每个订阅组配置几个重试队列 </td> 
 </tr> 
 <tr> 
 <td> -r&nbsp; </td> 
 <td> 否&nbsp; </td> 
 <td> 重试消费最大次数，超过则投递到死信队列，不再投递，并报警 </td> 
 </tr> 
 <tr> 
 <td> -s </td> 
 <td> 否 </td> 
 <td> 消费功能是否开启 </td> 
 </tr> 
 <tr> 
 <td> -w&nbsp; </td> 
 <td> 否 </td> 
 <td> 发现消息堆积后，将Consumer&nbsp;的消费请求重定向到另外一台Slave&nbsp;机器 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.4. 删除订阅组配置 ##

指令

deleteSubGroup

类路径

com.alibaba.rocketmq.tools.command.consumer.DeleteSubscriptionGroupCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b&nbsp; </td> 
 <td> 如果–c&nbsp;为空，则必填 </td> 
 <td> broker&nbsp;地址，表示订阅组建在该broker </td> 
 </tr> 
 <tr> 
 <td> -c&nbsp; </td> 
 <td> 如果–b&nbsp;为空，则必填 </td> 
 <td> cluster&nbsp;名称，表示topic建在该集群（集群可通过clusterList查询） </td> 
 </tr> 
 <tr> 
 <td> -g </td> 
 <td> 是 </td> 
 <td> 订阅组名 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n&nbsp; </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.5. 更新Broker 配置文件 ##

指令

updateBrokerConfig

类路径

com.alibaba.rocketmq.tools.command.broker.UpdateBrokerConfigSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b&nbsp; </td> 
 <td> 如果–c为空，则必填 </td> 
 <td> broker&nbsp;地址，表示订阅组建在该broker </td> 
 </tr> 
 <tr> 
 <td> -c&nbsp; </td> 
 <td> 如果–b&nbsp;为空，则必填 </td> 
 <td> cluster名称，表示topic&nbsp;建在该集群（集群可通过clusterList查询） </td> 
 </tr> 
 <tr> 
 <td> -k&nbsp; </td> 
 <td> 是 </td> 
 <td> &nbsp;key&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -v </td> 
 <td> 否 </td> 
 <td> value&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n&nbsp; </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.6. 查看Topic 列表信息 ##

指令

topicList

类路径

com.alibaba.rocketmq.tools.command.broker.UpdateBrokerConfigSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n&nbsp; </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.7. 查看Topic 路由信息 ##

指令

topicRoute

类路径

com.alibaba.rocketmq.tools.command.topic.TopicRouteSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> topic&nbsp;名称 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n&nbsp; </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.8. 查看Topic 统计信息 ##

指令

topicStats

类路径

com.alibaba.rocketmq.tools.command.topic.TopicStatsSubCommand

## 1.2.9. 查看Broker 统计信息 ##

指令

brokerStats

类路径

com.alibaba.rocketmq.tools.command.broker.BrokerStatsSubCommanD

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b </td> 
 <td> 是 </td> 
 <td> &nbsp;broker&nbsp;地址 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n&nbsp; </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.10. 根据消息ID 查询消息 ##

指令

queryMsgById

类路径

com.alibaba.rocketmq.tools.command.message.QueryMsgByIdSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -i </td> 
 <td> 是 </td> 
 <td> &nbsp;消息id </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n&nbsp; </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.11. 根据消息Key 查询消息 ##

指令

queryMsgByKey

类路径

com.alibaba.rocketmq.tools.command.message.QueryMsgByKeySubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -f </td> 
 <td> 否 </td> 
 <td> 被查询消息的截止时间 </td> 
 </tr> 
 <tr> 
 <td> -k </td> 
 <td> 是 </td> 
 <td> msgKey </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> topic&nbsp;名称 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.12. 根据Offset 查询消息 ##

指令

queryMsgByOffset

类路径

com.alibaba.rocketmq.tools.command.message.QueryMsgByOffsetSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b&nbsp; </td> 
 <td> 是 </td> 
 <td> Broker&nbsp;名称，表示订阅组建在该broker（这里需要注意填写的是broker&nbsp;的名称，不是broker&nbsp;的地址，broker名称可以在clusterList&nbsp;查到 </td> 
 </tr> 
 <tr> 
 <td> -i </td> 
 <td> 是 </td> 
 <td> query&nbsp;队列id </td> 
 </tr> 
 <tr> 
 <td> -o </td> 
 <td> 是 </td> 
 <td> offset&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> topic&nbsp;名称 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.13. 查询Producer 的网络连接 ##

该命令只打印当前与cluster 连接的producer 网络连接信息

指令

producerConnection

类路径

com.alibaba.rocketmq.tools.command.connection.ProducerConnectionSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -g </td> 
 <td> 是 </td> 
 <td> 生产者所属组名 </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> topic&nbsp;名称 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.14. 查询Consumer 的网络连接 ##

该命令只打印当前与cluster 连接的consumer 网络连接信息

指令

consumerConnection

类路径

com.alibaba.rocketmq.tools.command.connection.ConsumerConnectionSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -g </td> 
 <td> 是 </td> 
 <td> 消费者所属组名 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.15. 查看订阅组消费状态 ##

指令

consumerProgress

类路径

com.alibaba.rocketmq.tools.command.consumer.ConsumerProgressSubCommand

## 1.2.16. 查看集群消息 ##

指令

clusterList

类路径

com.alibaba.rocketmq.tools.command.cluster.ClusterListSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -m </td> 
 <td> 否 </td> 
 <td> 打印更多信息 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.17. 添加（更新）KV 配置信息 ##

指令

updateKvConfig

类路径

com.alibaba.rocketmq.tools.command.namesrv.UpdateKvConfigCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -k </td> 
 <td> 是 </td> 
 <td> key&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -v </td> 
 <td> 是 </td> 
 <td> value&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -s </td> 
 <td> 是 </td> 
 <td> Namespace&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.18. 删除KV 配置信息 ##

指令

deleteKvConfig

类路径

com.alibaba.rocketmq.tools.command.namesrv.DeleteKvConfigCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -k </td> 
 <td> 是 </td> 
 <td> key&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -s </td> 
 <td> 是 </td> 
 <td> Namespace&nbsp;值 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.19. 添加（更新）Project group 配置信息 ##

指令 updateProjectGroup

类路径 com.alibaba.rocketmq.tools.command.namesrv.UpdateProjectGroupCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -p </td> 
 <td> 是 </td> 
 <td> project&nbsp;group&nbsp;名 </td> 
 </tr> 
 <tr> 
 <td> -i </td> 
 <td> 否 </td> 
 <td> 服务器ip </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.20. 删除Project group 配置信息 ##

指令

deleteProjectGroup

类路径

com.alibaba.rocketmq.tools.command.namesrv.DeleteProjectGroupCommand

## 1.2.21. 取得Project group 配置信息 ##

指令

getProjectGroup

类路径

com.alibaba.rocketmq.tools.command.namesrv.GetProjectGroupCommand

## 1.2.22. 设置消费进度 ##

根据时间来设置消费进度，设置之前要关闭这个订阅组的所有consumer，设置完再启动，方可生效

指令

resetOffsetByTime

类路径

com.alibaba.rocketmq.tools.command.offset.ResetOffsetByTimeSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -f </td> 
 <td> 否 </td> 
 <td> 通过时间戳强制回滚（true|false），默认为true </td> 
 </tr> 
 <tr> 
 <td> -s </td> 
 <td> 是 </td> 
 <td> 时间戳 </td> 
 </tr> 
 <tr> 
 <td> -g </td> 
 <td> 是 </td> 
 <td> 消费者所属组名 </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> topic&nbsp;名称 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.23. 清除特定Broker权限 ##

指令

wipeWritePerm

类路径

com.alibaba.rocketmq.tools.command.namesrv.WipeWritePermSubCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -b </td> 
 <td> 是 </td> 
 <td> broker&nbsp;地址 </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>

## 1.2.24. 获取Consumer消费进度 ##

该命令只打印当前与cluster 连接的consumer 的消费进度

指令

getConsumerStatus

类路径

com.alibaba.rocketmq.tools.command.offset.GetConsumerStatusCommand

<table> 
 <tbody> 
 <tr> 
 <td> 参数 </td> 
 <td> 是否必填 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> -g </td> 
 <td> 是 </td> 
 <td> 消费者所属组名 </td> 
 </tr> 
 <tr> 
 <td> -t </td> 
 <td> 是 </td> 
 <td> 查询主题 </td> 
 </tr> 
 <tr> 
 <td> -i </td> 
 <td> 否 </td> 
 <td> Consumer&nbsp;客户端ip </td> 
 </tr> 
 <tr> 
 <td> -h </td> 
 <td> 否 </td> 
 <td> 打印帮助 </td> 
 </tr> 
 <tr> 
 <td> -n </td> 
 <td> 是 </td> 
 <td> nameserve&nbsp;服务地址列表，格式ip:port;ip:port;... </td> 
 </tr> 
 </tbody> 
</table>