參考文檔
http://jameswxx.iteye.com/blog/2091971
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
| 參數 |
是否必填 |
說明 |
| -b |
如果-c為空，則必填 |
broker 地址，表示topic 建在該broker |
| -c |
如果-b為空，則必填 |
cluster 名稱，表示topic 建在該集群（集群可通過clusterList 查詢） |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
| -p |
否 |
指定新topic 的權限限制( W|R|WR ) |
| -r |
否 |
可讀隊列數（默認為8） |
| -w |
否 |
可寫隊列數（默認為8） |
| -t |
是 |
opic 名稱（名稱只能使用字符 ^[a-zA-Z0-9_-]+$ ） |
1.2.2. 刪除Topic
指令
deleteTopic
類路徑
com.alibaba.rocketmq.tools.command.topic.DeleteTopicSubCommand
| 參數 |
是否必填 |
說明 |
| -c |
是 |
cluster 名稱，表示刪除某集群下的某個topic （集群可通過clusterList 查詢） |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;… |
| -t |
是 |
topic 名稱（名稱只能使用字符 ^[a-zA-Z0-9_-]+$ ） |
1.2.3. 創建（修訂）訂閱組
指令
updateSubGroup
類路徑
com.alibaba.rocketmq.tools.command.consumer.UpdateSubGroupSubCommand
| 參數 |
是否必填 |
說明 |
| -b |
如果 –c 為空，則必填 |
broker 地址，表示訂閱組建在該broker |
| -c |
如果 –b 為空，則必填 |
cluster名稱，表示topic 建在該集群（集群可通過clusterList查詢） |
| -d |
否 |
是否容許廣播方式消費 |
| -g |
是 |
訂閱組名 |
| -i |
否 |
從哪個broker 開始消費 |
| -m |
否 |
是否容許從隊列的最小位置開始消費，默認會設置為false |
| -q |
否 |
消費失敗的消息放到一個重試隊列，每個訂閱組配置幾個重試隊列 |
| -r |
否 |
重試消費最大次數，超過則投遞到死信隊列，不再投遞，並報警 |
| -s |
否 |
消費功能是否開啟 |
| -w |
否 |
發現消息堆積后，將Consumer 的消費請求重定向到另外一台Slave 機器 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.4. 刪除訂閱組配置
指令
deleteSubGroup
類路徑
com.alibaba.rocketmq.tools.command.consumer.DeleteSubscriptionGroupCommand
| 參數 |
是否必填 |
說明 |
| -b |
如果–c 為空，則必填 |
broker 地址，表示訂閱組建在該broker |
| -c |
如果–b 為空，則必填 |
cluster 名稱，表示topic建在該集群（集群可通過clusterList查詢） |
| -g |
是 |
訂閱組名 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.5. 更新Broker 配置文件
指令
updateBrokerConfig
類路徑
com.alibaba.rocketmq.tools.command.broker.UpdateBrokerConfigSubCommand
| 參數 |
是否必填 |
說明 |
| -b |
如果–c為空，則必填 |
broker 地址，表示訂閱組建在該broker |
| -c |
如果–b 為空，則必填 |
cluster名稱，表示topic 建在該集群（集群可通過clusterList查詢） |
| -k |
是 |
key 值 |
| -v |
否 |
value 值 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.6. 查看Topic 列表信息
指令
topicList
類路徑
com.alibaba.rocketmq.tools.command.broker.UpdateBrokerConfigSubCommand
| 參數 |
是否必填 |
說明 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.7. 查看Topic 路由信息
指令
topicRoute
類路徑
com.alibaba.rocketmq.tools.command.topic.TopicRouteSubCommand
| 參數 |
是否必填 |
說明 |
| -t |
是 |
topic 名稱 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.8. 查看Topic 統計信息
指令
topicStats
類路徑
com.alibaba.rocketmq.tools.command.topic.TopicStatsSubCommand
| 參數 |
是否必填 |
說明 |
| -t |
是 |
topic 名稱 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.9. 查看Broker 統計信息
指令
brokerStats
類路徑
com.alibaba.rocketmq.tools.command.broker.BrokerStatsSubCommanD
| 參數 |
是否必填 |
說明 |
| -b |
是 |
broker 地址 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.10. 根據消息ID 查詢消息
指令
queryMsgById
類路徑
com.alibaba.rocketmq.tools.command.message.QueryMsgByIdSubCommand
| 參數 |
是否必填 |
說明 |
| -i |
是 |
消息id |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.11. 根據消息Key 查詢消息
指令
queryMsgByKey
類路徑
com.alibaba.rocketmq.tools.command.message.QueryMsgByKeySubCommand
| 參數 |
是否必填 |
說明 |
| -f |
否 |
被查詢消息的截止時間 |
| -k |
是 |
msgKey |
| -t |
是 |
topic 名稱 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.12. 根據Offset 查詢消息
指令
queryMsgByOffset
類路徑
com.alibaba.rocketmq.tools.command.message.QueryMsgByOffsetSubCommand
| 參數 |
是否必填 |
說明 |
| -b |
是 |
Broker 名稱，表示訂閱組建在該broker（這里需要注意填寫的是broker 的名稱，不是broker 的地址，broker名稱可以在clusterList 查到 |
| -i |
是 |
query 隊列id |
| -o |
是 |
offset 值 |
| -t |
是 |
topic 名稱 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.13. 查詢Producer 的網絡連接
該命令只打印當前與cluster 連接的producer 網絡連接信息
指令
producerConnection
類路徑
com.alibaba.rocketmq.tools.command.connection.ProducerConnectionSubCommand
| 參數 |
是否必填 |
說明 |
| -g |
是 |
生產者所屬組名 |
| -t |
是 |
topic 名稱 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.14. 查詢Consumer 的網絡連接
該命令只打印當前與cluster 連接的consumer 網絡連接信息
指令
consumerConnection
類路徑
com.alibaba.rocketmq.tools.command.connection.ConsumerConnectionSubCommand
| 參數 |
是否必填 |
說明 |
| -g |
是 |
消費者所屬組名 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.15. 查看訂閱組消費狀態
指令
consumerProgress
類路徑
com.alibaba.rocketmq.tools.command.consumer.ConsumerProgressSubCommand
| 參數 |
是否必填 |
說明 |
| -g |
是 |
消費者所屬組名 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.16. 查看集群消息
指令
clusterList
類路徑
com.alibaba.rocketmq.tools.command.cluster.ClusterListSubCommand
| 參數 |
是否必填 |
說明 |
| -m |
否 |
打印更多信息 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.17. 添加（更新）KV 配置信息
指令
updateKvConfig
類路徑
com.alibaba.rocketmq.tools.command.namesrv.UpdateKvConfigCommand
| 參數 |
是否必填 |
說明 |
| -k |
是 |
key 值 |
| -v |
是 |
value 值 |
| -s |
是 |
Namespace 值 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.18. 刪除KV 配置信息
指令
deleteKvConfig
類路徑
com.alibaba.rocketmq.tools.command.namesrv.DeleteKvConfigCommand
| 參數 |
是否必填 |
說明 |
| -k |
是 |
key 值 |
| -s |
是 |
Namespace 值 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.19. 添加（更新）Project group 配置信息
指令 updateProjectGroup
類路徑 com.alibaba.rocketmq.tools.command.namesrv.UpdateProjectGroupCommand
| 參數 |
是否必填 |
說明 |
| -p |
是 |
project group 名 |
| -i |
否 |
服務器ip |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.20. 刪除Project group 配置信息
指令
deleteProjectGroup
類路徑
com.alibaba.rocketmq.tools.command.namesrv.DeleteProjectGroupCommand
| 參數 |
是否必填 |
說明 |
| -p |
是 |
project group 名 |
| -i |
否 |
服務器ip |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.21. 取得Project group 配置信息
指令
getProjectGroup
類路徑
com.alibaba.rocketmq.tools.command.namesrv.GetProjectGroupCommand
| 參數 |
是否必填 |
說明 |
| -p |
是 |
project group 名 |
| -i |
否 |
服務器ip |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.22. 設置消費進度
根據時間來設置消費進度，設置之前要關閉這個訂閱組的所有consumer，設置完再啟動，方可生效
指令
resetOffsetByTime
類路徑
com.alibaba.rocketmq.tools.command.offset.ResetOffsetByTimeSubCommand
| 參數 |
是否必填 |
說明 |
| -f |
否 |
通過時間戳強制回滾（true|false），默認為true |
| -s |
是 |
時間戳 |
| -g |
是 |
消費者所屬組名 |
| -t |
是 |
topic 名稱 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.23. 清除特定Broker權限
指令
wipeWritePerm
類路徑
com.alibaba.rocketmq.tools.command.namesrv.WipeWritePermSubCommand
| 參數 |
是否必填 |
說明 |
| -b |
是 |
broker 地址 |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |
1.2.24. 獲取Consumer消費進度
該命令只打印當前與cluster 連接的consumer 的消費進度
指令
getConsumerStatus
類路徑
com.alibaba.rocketmq.tools.command.offset.GetConsumerStatusCommand
| 參數 |
是否必填 |
說明 |
| -g |
是 |
消費者所屬組名 |
| -t |
是 |
查詢主題 |
| -i |
否 |
Consumer 客戶端ip |
| -h |
否 |
打印幫助 |
| -n |
是 |
nameserve 服務地址列表，格式ip:port;ip:port;... |