+
+
+
+
+
+ | name |
+ meaning |
+ command items |
+ explaination |
+
+
+ | updateTopic |
+ create or update Topic's config |
+ -b |
+ Broker address, means which Broker that topic is located, only support single Broker, address format is ip:port |
+
+
+ | -c |
+ cluster name, whic cluster that topic belongs to(query cluster info by clusterList) |
+
+
+ | -h- |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -p |
+ assign read write authority to new topic(W=2|R=4|WR=6) |
+
+
+ | -r |
+ the count of queue that can be read(default is 8) |
+
+
+ | -w |
+ the count of queue that can be wrote(default is 8) |
+
+
+ | -t |
+ topic name(can only use characters ^[a-zA-Z0-9_-]+$ ) |
+
+
+ | deleteTopic |
+ delete Topic |
+ -c |
+ cluster name, which cluster that topic will be deleted belongs to(query cluster info by clusterList) |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic name(can only use characters ^[a-zA-Z0-9_-]+$ ) |
+
+
+ | topicList |
+ query Topic list info |
+ -h |
+ print help info |
+
+
+ | -c |
+ return topic list only if do not contains -c, if containis -c, it will return cluster name, topic name, consumer group name |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | topicRoute |
+ query Topic's route info |
+ -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | topicStatus |
+ query Topic's offset |
+ -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | topicClusterList |
+ query cluster list where Topic belongs to |
+ -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | updateTopicPerm |
+ update Topic's produce and consume authority |
+ -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -b |
+ Broker address which topic belongs to, support single broker only, format is ip:port |
+
+
+ | -p |
+ assign read and write authority to the new topic(W=2|R=4|WR=6) |
+
+
+ | -c |
+ cluster name, which topic belongs to(query cluster info by clusterList), if do not have -b, execute comman an all brokers. |
+
+
+ | updateOrderConf |
+ create delete get specified namespace's kv config from NameServer, have not enabled at present |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic, key |
+
+
+ | -v |
+ orderConf, value |
+
+
+ | -m |
+ method, including get, put, delete |
+
+
+ | allocateMQ |
+ calculate consumer list rebalance result by average rebalance algorithm |
+ -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -i |
+ ipList, seperate by comma, calculate which topic queue that ips will load. |
+
+
+ | statsAll |
+ print Topic's subscribe info, TPS, size of message blocked, count of read and write at last 24h, eg. |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -a |
+ only print active topic or not |
+
+
+ | -t |
+ assign topic |
+
+
+
+
+
+#### 2.2 Cluster
+
+
+
+
+
+
+
+ | 名称 |
+ meaning |
+ command items |
+ explaination |
+
+
+ | clusterList |
+ query cluster info, including cluster, BrokerName, BrokerId, TPS, eg. |
+ -m |
+ print more infos(eg: #InTotalYest, #OutTotalYest, #InTotalToday ,#OutTotalToday) |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -i |
+ print interval, unit second |
+
+
+ | clusterRT |
+ send message to detect each cluster's Broker RT. Message will be sent to ${BrokerName} Topic。 |
+ -a |
+ amount, count of detection, RT = sum time /
+ amount |
+
+
+ | -s |
+ size of message, unit B |
+
+
+ | -c |
+ which cluster will be detected |
+
+
+ | -p |
+ whether print format log, splitted by |, default is not print |
+
+
+ | -h |
+ print help info |
+
+
+ | -m |
+ which machine room it belongs to, just for print |
+
+
+ | -i |
+ send interval, unit second |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+
+
+#### 2.3 Broker
+
+
+
+
+
+
+
+ | 名称 |
+ meaning |
+ command items |
+ explaination |
+
+
+ | updateBrokerConfig |
+ update Broker's config file, it will modify Broker.conf |
+ -b |
+ Broker address, format is ip:port |
+
+
+ | -c |
+ cluster name |
+
+
+ | -k |
+ key |
+
+
+ | -v |
+ value |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | brokerStatus |
+ get Broker's statistics info, running status(including whatever you want). |
+ -b |
+ Broker address, fomat isip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | brokerConsumeStats |
+ Broker's consumer info, including Consume Offset, Broker Offset, Diff, Timestamp that ordered by essage Queue |
+ -b |
+ Broker address, fomat isip:port |
+
+
+ | -t |
+ request timeout time |
+
+
+ | -l |
+ diff threshold, it will print when exceed this threshold. |
+
+
+ | -o |
+ whether is sequencial topic, generally false |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | getBrokerConfig |
+ get Broker's config |
+ -b |
+ Broker address, fomat isip:port |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | wipeWritePerm |
+ revoke broker's write authority from NameServer. |
+ -b |
+ Broker address, fomat isip:port |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | cleanExpiredCQ |
+ clean Broker's expired Consume Queue that maybe generated by decrease queue count. |
+ -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -b |
+ Broker address, fomat isip:port |
+
+
+ | -c |
+ cluster name |
+
+
+ | cleanUnusedTopic |
+ clean Broker's unused Topic that deleted mannually to release memory that Topic's Consume Queue occupied. |
+ -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -b |
+ Broker address, fomat isip:port |
+
+
+ | -c |
+ cluster name |
+
+
+ | sendMsgStatus |
+ send message to Broker, return send status and RT |
+ -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -b |
+ BrokerName, is different from broker address |
+
+
+ | -s |
+ message size, unit B |
+
+
+ | -c |
+ send count |
+
+
+
+
+#### 2.4 Message
+
+
+
+
+
+
+
+ | 名称 |
+ meaning |
+ command items |
+ explaination |
+
+
+ | queryMsgById |
+ query message by offsetMsgId. If use opensource console, it should use offsetMsgId. Please refer to QueryMsgByIdSubCommand for detail. |
+ -i |
+ msgId |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | queryMsgByKey |
+ query message by Message's Key |
+ -k |
+ msgKey |
+
+
+ | -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | queryMsgByOffset |
+ query message by Offset |
+ -b |
+ Broker name(it's not broker address, can query Broker name by clusterList). |
+
+
+ | -i |
+ query queue id |
+
+
+ | -o |
+ offset value |
+
+
+ | -t |
+ topic name |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | queryMsgByUniqueKey |
+ query by msgId, msgId is different from offsetMsgId, please refer to Frequently asked questions about operations for details. Use -g and -d to let specified consumer return consume result. |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -i |
+ uniqe msg id |
+
+
+ | -g |
+ consumerGroup |
+
+
+ | -d |
+ clientId |
+
+
+ | -t |
+ topic name |
+
+
+ | checkMsgSendRT |
+ detect RT of sending a message to a topic, similiar to clusterRT |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic name |
+
+
+ | -a |
+ detection count |
+
+
+ | -s |
+ size of the message |
+
+
+ | sendMessage |
+ send a message, also can send to a specified Message Queue. |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic name |
+
+
+ | -p |
+ body, message entity |
+
+
+ | -k |
+ keys |
+
+
+ | -c |
+ tags |
+
+
+ | -b |
+ BrokerName |
+
+
+ | -i |
+ queueId |
+
+
+ | consumeMessage |
+ consume message. Differert consume logic depends on offset, start & end timestamp, message queue, please refer to ConsumeMessageCommand for details. |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic name |
+
+
+ | -b |
+ BrokerName |
+
+
+ | -o |
+ offset that consumer start consume |
+
+
+ | -i |
+ queueId |
+
+
+ | -g |
+ consumer gropu |
+
+
+ | -s |
+ timestamp at start, refer to -h to get format开 |
+
+
+ | -d |
+ timestamp at the end |
+
+
+ | -c |
+ size of message that consumed |
+
+
+ | printMsg |
+ consume and print messages from broker, support a time range |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic name |
+
+
+ | -c |
+ charset, eg: UTF-8 |
+
+
+ | -s |
+ subExpress, filter expression |
+
+
+ | -b |
+ timestap at start, refer to -h to get format |
+
+
+ | -e |
+ timestamp at the end |
+
+
+ | -d |
+ whether print message entity or not |
+
+
+ | printMsgByQueue |
+ similar to printMsg, but it need specified Message Queue |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -t |
+ topic name |
+
+
+ | -i |
+ queueId |
+
+
+ | -a |
+ BrokerName |
+
+
+ | -c |
+ charset, eg: UTF-8 |
+
+
+ | -s |
+ subExpress, filter expression |
+
+
+ | -b |
+ timestamp at start, refer to -h to get format |
+
+
+ | -e |
+ timestamp at the end |
+
+
+ | -p |
+ whether print message or not |
+
+
+ | -d |
+ whether print message entity or not |
+
+
+ | -f |
+ whether count and print tag or not |
+
+
+ | resetOffsetByTime |
+ reset offset by timestamp, Broker and consumer will all be reseted |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -g |
+ consumer group |
+
+
+ | -t |
+ topic name |
+
+
+ | -s |
+ reset offset corresponding to this timestamp |
+
+
+ | -f |
+ whether enforce to reset or not, if set false, only can reset offset, if set true, it omit the relationship between timestamp and consumer offset. |
+
+
+ | -c |
+ whether reset c++ sdk's offset or not |
+
+
+
+
+#### 2.5 Consumer, Consumer Group
+
+
+
+
+
+
+
+ | name |
+ meaning |
+ command items |
+ explaination |
+
+
+ | consumerProgress |
+ query subscribe status, can get blocking counts of a concrete client ip. |
+ -g |
+ consumer group name |
+
+
+ | -s |
+ whether print client IP or not |
+
+
+ | -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | consumerStatus |
+ query consumer status, including message blocking, and consumer's jstack result(please refer to ConsumerStatusSubCommand) |
+ -h |
+ print help info |
+
+
+ | -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -g |
+ consumer group |
+
+
+ | -i |
+ clientId |
+
+
+ | -s |
+ whether execute jstack or not |
+
+
+ | updateSubGroup |
+ create or update subscribe info |
+ -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -b |
+ Broker address |
+
+
+ | -c |
+ cluster name |
+
+
+ | -g |
+ consumer group name |
+
+
+ | -s |
+ consumer group is allowed to consume or not |
+
+
+ | -m |
+ start consume from minimal offset or not |
+
+
+ | -d |
+ broadcast mode or not |
+
+
+ | -q |
+ capacity of retry queue |
+
+
+ | -r |
+ max retry count |
+
+
+ | -i |
+ It works when slaveReadEnable enabled, and that not consumed from slave. Suggesting that consume from slave node by specify slave id. |
+
+
+ | -w |
+ If broker consume from slave, whic slave node depends on this config that configed by BrokerId, eg: 1. |
+
+
+ | -a |
+ whether notify other consumers to rebalance or not when the count of consumer changes |
+
+
+ | deleteSubGroup |
+ delete subscribe info from Broker |
+ -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -b |
+ Broker address |
+
+
+ | -c |
+ cluster name |
+
+
+ | -g |
+ consumer group name |
+
+
+ | cloneGroupOffset |
+ use source group's offset at target group |
+ -n |
+ NameServer Service address, format is ip:port |
+
+
+ | -h |
+ print help info |
+
+
+ | -s |
+ source consumer group |
+
+
+ | -d |
+ target consumer group |
+
+
+ | -t |
+ topic name |
+
+
+ | -o |
+ not used at present |
+
+
+
+
+
+
+#### 2.6 Connection
+
+