管理ツール
注意
- コマンドを実行するには：
./mqadmin {command} {args} - ほとんどのコマンドでは、
-nフラグを使ってNameServerアドレスをip:port形式で設定する必要があります - ほとんどのコマンドでは、
-hフラグでヘルプを表示できます。 - Brokerアドレス (
-b) と clusterName (-c) の両方が設定されている場合、コマンドはBrokerアドレスを使用して実行されます。Brokerアドレスが設定されていない場合、コマンドはクラスタ内のすべてのホストで実行されます。サポートされるBrokerアドレスは1つのみで、形式はip:portです。ここで、ポートはデフォルトで10911です。 toolsディレクトリには多くのコマンドがありますが、そのすべてが使用できるわけではありません。MQAdminStartupで初期化されたもののみが使用できます。このクラスを修正して、独自のコマンドを追加または定義することもできます。- バージョンアップデートにより、一部のコマンドが更新されていない場合があり、エラーが発生する可能性があります。その場合は、関連するコマンドのソースコードをお読みください。
トピック関連
トピック関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| updateTopic | トピック設定を作成/更新する | -b | トピックが存在するBrokerアドレス。単一のBrokerのみサポートされ、アドレスの形式はip:portです。 |
| -c | トピックが存在するクラスタ名（クラスタはclusterListコマンドでクエリできます）。 | ||
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -p | 新しいトピックの読み書き権限を指定します (W=2|R=4|WR=6) | ||
| -r | 読み取り可能なキューの数（デフォルトは8） | ||
| -w | 書き込み可能なキューの数（デフォルトは8） | ||
| -t | トピック名 (名前には^[a-zA-Z0-9_-]+$の文字のみ使用できます) | ||
| deleteTopic | トピックを削除 | -c | クラスタ名。特定のクラスタ下で特定のトピックを削除することを表します（クラスタはclusterListコマンドでクエリできます）。 |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 (名前には^[a-zA-Z0-9_-]+$の文字のみ使用できます) | ||
| topicList | トピックリスト情報を照会する | -h | ヘルプを表示 |
| -c | -cフラグがない場合は、トピックリストのみが返されます。-cを追加すると、クラスタ名、トピック、コンシューマーグループの情報、つまりトピックが属するクラスタとサブスクリプションの関係が返されます。パラメータはありません。 | ||
| -n | NameServerアドレス。形式はip:port | ||
| topicRoute | トピックルーティング情報を照会する | -t | トピック名 |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| topicStatus | トピックメッセージキューのオフセットを照会する | -t | トピック名 |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| topicClusterList | トピックが配置されているクラスタのリストを照会する | -t | トピック名 |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| updateTopicPerm | トピックの読み書き権限を更新する | -t | トピック名 |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -b | トピックが存在するBrokerアドレス。単一のBrokerのみサポートされ、アドレスの形式はip:portです。 | ||
| -p | 新しいトピックの読み書き権限を指定します (W=2|R=4|WR=6) | ||
| -c | クラスタ名。トピックが存在するクラスタを表します（クラスタはclusterListコマンドでクエリできます）。-bフラグが優先されます。-bフラグがない場合、コマンドはクラスタ内のすべてのBrokerで実行されます。 | ||
| updateOrderConf | NameServerから特定のkv構成を作成、削除、および取得します。この機能は現在利用できません。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | topic,key | ||
| -v | orderConf,value | ||
| -m | method、オプションはget、put、delete | ||
| allocateMQ | 平均負荷アルゴリズムを使用して、コンシューマーリストのメッセージキューの負荷結果を計算します。 | -t | トピック名 |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -i | カンマ区切りのipList。トピックに対するこれらのIPのメッセージキューの負荷を計算します。 | ||
| statsAll | トピックのサブスクリプション、TPS、蓄積、24時間の読み書き合計量などの情報を出力します。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -a | アクティブなトピックのみを出力する | ||
| -t | トピックを指定 |
クラスタ関連
クラスタ関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| clusterList | クラスタ、BrokerName、BrokerId、TPSなどの情報を含む、クラスタ情報を照会します。 | -m | より多くの情報を出力します (出力される追加情報には、#InTotalYest、#OutTotalYest、#InTotalToday、#OutTotalTodayが含まれます) |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -i | 間隔を秒単位で出力します。 | ||
| clusterRT | クラスタ内の各BrokerのRTをテストするためにメッセージを送信します。メッセージは$に送信されます。{BrokerName}トピック。 | -a | amount、各プローブの合計数。RT = 合計時間 / amount |
| -s | メッセージサイズ、単位：B | ||
| -c | プローブするクラスタ | ||
| -p | フォーマットされたログを|で区切って出力するかどうか。デフォルトでは出力しません。 | ||
| -h | ヘルプを表示 | ||
| -m | 印刷用の所属データセンター。 | ||
| -i | 送信間隔（秒単位）。 | ||
| -n | NameServerアドレス。形式はip:port |
Broker関連
Broker関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| queryMsgById | offsetMsgIdに基づいてmsgを照会します。オープンソースコンソールを使用している場合は、offsetMsgIdを使用する必要があります。このコマンドには追加のパラメータがあります。機能の詳細については、QueryMsgByIdSubCommandを参照してください。 | -i | msgId |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| queryMsgByKey | メッセージキーに基づいてメッセージを照会します。 | -k | msgKey |
| -t | トピック名 | ||
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| queryMsgByOffset | オフセットに基づいてメッセージを照会します。 | -b | Broker名 (アドレスではなく、Brokerの名前を入力する必要があることに注意してください。Broker名はclusterListコマンドを使用して確認できます)。 |
| -i | キューIDを照会する | ||
| -o | オフセット値 | ||
| -t | トピック名 | ||
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| queryMsgByUniqueKey | msgIdに基づいて照会します。msgIdはoffsetMsgIdとは異なります。詳細については、一般的な運用上の問題を参照してください。-gと-dを一緒に使用して、メッセージが見つかった後、特定のコンシューマーにメッセージを消費させ、消費結果を返します。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -i | 一意のメッセージID | ||
| -g | コンシューマーグループ | ||
| -d | clientId | ||
| -t | トピック名 | ||
| checkMsgSendRT | トピックへのメッセージ送信のRTを確認します。機能はclusterRTに似ています。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -a | プローブの数 | ||
| -s | メッセージサイズ | ||
| sendMessage | メッセージを送信します。設定に基づいて特定のメッセージキューに送信したり、通常送信したりできます。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -p | メッセージ本文 | ||
| -k | キー | ||
| -c | タグ | ||
| -b | BrokerName | ||
| -i | queueId | ||
| consumeMessage | メッセージを消費します。メッセージは、オフセット、開始/終了タイムスタンプ、メッセージキューに基づいて消費できます。異なる構成では、異なる消費ロジックが実行されます。詳細については、ConsumeMessageCommandを参照してください。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -b | BrokerName | ||
| -o | オフセットから消費 | ||
| -i | queueId | ||
| -g | コンシューマーグループ | ||
| -s | 開始タイムスタンプ。形式については-hを参照してください。 | ||
| -d | 終了タイムスタンプ | ||
| -c | 特定の数のメッセージを消費する | ||
| printMsg | Brokerからメッセージを消費して出力します。オプションで期間を指定できます。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -c | 文字セット (例: UTF-8) | ||
| -s | subExpress、フィルター式 | ||
| -b | 開始タイムスタンプ。形式については-hを参照してください。 | ||
| -e | 終了タイムスタンプ | ||
| -d | メッセージ本文を出力するかどうか。 | ||
| printMsgByQueue | printMsgに似ていますが、特定のメッセージキュー用です。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -i | queueId | ||
| -a | BrokerName | ||
| -c | 文字セット (例: UTF-8) | ||
| -s | subExpress、フィルター式 | ||
| -b | 開始タイムスタンプ。形式については-hを参照してください。 | ||
| -e | 終了タイムスタンプ | ||
| -p | メッセージ本文を出力するかどうか。 | ||
| -d | メッセージ本文を出力するかどうか。 | ||
| -f | タグの数をカウントして出力するかどうか | ||
| resetOffsetByTime | タイムスタンプに基づいてオフセットをリセットします。Brokerとコンシューマーの両方がリセットされます。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -g | コンシューマーグループ | ||
| -t | トピック名 | ||
| -s | このタイムスタンプに対応するオフセットにリセットします。 | ||
| -f | 強制的にリセットするかどうか。falseの場合、後方オフセットのみがサポートされます。trueの場合、タイムスタンプに対応するオフセットとconsumeOffsetの関係に関係なくリセットされます。 | ||
| -c | C++クライアントのオフセットをリセットするかどうか。 |
メッセージ関連
メッセージ関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| queryMsgById | オフセットメッセージID (offsetMsgId) でメッセージを照会するには、オープンソースコンソールを使用している場合は、offsetMsgIdコマンドを使用できます。このコマンドには追加のパラメータがあり、その具体的な機能はQueryMsgByIdSubCommandを読むことで確認できます。 | -i | msgId |
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| queryMsgByKey | キーでメッセージを照会します。 | -k | msgKey |
| -t | トピック名 | ||
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| queryMsgByOffset | オフセットでメッセージを照会します | -b | Broker名 (これはアドレスではなく、Brokerの名前である必要があります。Brokerの名前はclusterListで確認できます)。 |
| -i | キューIDを照会する | ||
| -o | オフセット値 | ||
| -t | トピック名 | ||
| -h | ヘルプを表示 | ||
| -n | NameServerアドレス。形式はip:port | ||
| queryMsgByUniqueKey | msgIdに基づいてクエリします。msgIdはoffsetMsgIdとは異なることに注意してください。詳細については、一般的な運用とメンテナンスの問題を参照してください。メッセージが見つかったら、-gと-dを一緒に使用して、特定のコンシューマーにメッセージを消費させ、消費結果を返してみてください。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -i | 一意のメッセージID | ||
| -g | コンシューマーグループ | ||
| -d | clientId | ||
| -t | トピック名 | ||
| checkMsgSendRT | トピックへのメッセージ送信のRT (ラウンドトリップ時間) を確認します。この機能はclusterRTに似ています。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -a | プローブの数。 | ||
| -s | メッセージサイズ | ||
| sendMessage | メッセージを送信します。設定に応じて特定のメッセージキューに送信したり、通常どおり送信したりできます。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -p | 本文、メッセージ本文 | ||
| -k | キー | ||
| -c | タグ | ||
| -b | BrokerName | ||
| -i | queueId | ||
| consumeMessage | メッセージを消費します。メッセージは、オフセット、開始/終了タイムスタンプ、メッセージキューに基づいて消費できます。構成が異なると、異なる消費ロジックが実行されます。詳細については、ConsumeMessageCommandを参照してください。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -b | BrokerName | ||
| -o | 指定されたオフセットから消費します。 | ||
| -i | queueId | ||
| -g | コンシューマーグループ | ||
| -s | 開始タイムスタンプ。形式については-hを参照してください。 | ||
| -d | 終了タイムスタンプ | ||
| -c | 指定された数のメッセージを消費します。 | ||
| printMsg | 指定された期間内にBrokerからメッセージを消費して出力します。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -c | 文字セット (例: UTF-8) | ||
| -s | subExpress、フィルター式 | ||
| -b | 開始タイムスタンプ。形式については-hを参照してください。 | ||
| -e | 終了タイムスタンプ | ||
| -d | メッセージ本文を出力するかどうか | ||
| printMsgByQueue | printMsgに似ていますが、メッセージキューを指定します。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -t | トピック名 | ||
| -i | queueId | ||
| -a | BrokerName | ||
| -c | 文字セット (例: UTF-8) | ||
| -s | subExpress、フィルター式 | ||
| -b | 開始タイムスタンプ。形式については-hを参照してください。 | ||
| -e | 終了タイムスタンプ | ||
| -p | メッセージを出力するかどうか | ||
| -d | メッセージ本文を出力するかどうか | ||
| -f | タグの数をカウントして出力するかどうか | ||
| resetOffsetByTime | タイムスタンプでオフセットをリセットすると、Brokerとコンシューマーの両方がリセットされます。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -g | コンシューマーグループ | ||
| -t | トピック名 | ||
| -s | このタイムスタンプに対応するオフセットにリセットします。 | ||
| -f | 強制的にリセットするかどうか。falseの場合、後方オフセットのみがサポートされます。trueの場合、タイムスタンプに対応するオフセットとconsumeOffsetの関係は無視されます。 | ||
| -c | C++クライアントのオフセットをリセットするかどうか。 |
消費関連
消費関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| consumerProgress | 特定のクライアントIPのメッセージの蓄積を含む、コンシューマーグループの消費状況。 | -g | コンシューマーグループ名 |
| -s | クライアントIPを出力するかどうか。 | ||
| -h | ヘルプを出力 | ||
| -n | NameServerアドレス。形式はip:port | ||
| consumerStatus | コンシューマーステータスとは、同じグループ内のすべてのコンシューマーが同じサブスクリプションを持っているかどうか、プロセスキューがスタックしているかどうか、およびコンシューマーのjstackの結果など、コンシューマーの状態を指します。このコマンドによって返される情報は広範囲にわたるため、ユーザーは詳細についてConsumerStatusSubCommandを参照する必要があります。 | -h | ヘルプを表示 |
| -n | NameServerアドレス。形式はip:port | ||
| -g | コンシューマーグループ | ||
| -i | clientId | ||
| -s | jstackを実行するかどうか | ||
| getConsumerStatus | コンシューマーの消費進捗を取得する | -g | コンシューマーグループ名 |
| -t | トピックを照会 | ||
| -i | コンシューマーのクライアントIP | ||
| -n | NameServerアドレス。形式はip:port | ||
| -h | ヘルプを表示 | ||
| updateSubGroup | サブスクリプション関係を更新または作成します。 | -n | NameServerアドレス。形式はip:port |
| -h | ヘルプを表示 | ||
| -b | Brokerアドレス | ||
| -c | クラスタ名 | ||
| -g | コンシューマーグループ名 | ||
| -s | グループが消費を許可されているかどうか | ||
| -m | 最小オフセットから消費を開始するかどうか。 | ||
| -d | ブロードキャストモードであるかどうか。 | ||
| -q | リトライキューの数。 | ||
| -r | 最大リトライ数 | ||
| -i | slaveReadEnable がオンになっており、スレーブからの消費が推奨される時点にまだ達していない場合、スタンバイマシンのIDを設定して、アクティブにスタンバイマシンから消費させることができます。 | ||
| -w | ブローカーがスレーブからの消費を推奨する場合、設定によってどのスレーブから消費するかが決定されます。例えば、BrokerId を 1 に設定できます。 | ||
| -a | コンシューマーの数が変更されたときに、他のコンシューマーに負荷分散が通知されるかどうか。 | ||
| deleteSubGroup | ブローカーからサブスクリプションを削除します。 | -n | NameServerアドレス。形式はip:port |
| -h | ヘルプを表示 | ||
| -b | Brokerアドレス | ||
| -c | クラスタ名 | ||
| -g | コンシューマーグループ名 | ||
| cloneGroupOffset | ターゲットコンシューマーグループで、ソースコンシューマーグループのオフセットを使用します。 | -n | NameServerアドレス。形式はip:port |
| -h | ヘルプを表示 | ||
| -s | ソースコンシューマーグループ | ||
| -d | ターゲットコンシューマーグループ | ||
| -t | topicname | ||
| -o | 現在使用されていません。 |
接続関連
接続関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| consumerConnec tion | コンシューマーのネットワーク接続をクエリします。 | -g | コンシューマーグループの名前。 |
| -n | NameServerアドレス。形式はip:port | ||
| -h | ヘルプを表示 | ||
| producerConnec tion | プロデューサーのネットワーク接続をクエリします。 | -g | プロデューサーグループの名前。 |
| -t | トピック名 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -h | ヘルプを表示 |
NameServer関連
接続関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| updateKvConfig | NameServer KV 設定を更新します。現在、使用されていません。 | -s | ネームスペース |
| -k | キー | ||
| -v | 値 | ||
| -n | NameServerアドレス。形式はip:port | ||
| -h | ヘルプを表示 | ||
| deleteKvConfig | NameServer KV 設定を削除します。 | -s | ネームスペース |
| -k | キー | ||
| -n | NameServerアドレス。形式はip:port | ||
| -h | ヘルプを表示 | ||
| getNamesrvConfig | NameServer の設定を取得します。 | -n | NameServerアドレス。形式はip:port |
| -h | ヘルプを表示 | ||
| updateNamesrvConfig | NameServer の設定を変更します。 | -n | NameServerアドレス。形式はip:port |
| -h | ヘルプを表示 | ||
| -k | キー | ||
| -v | 値 |
その他
接続関連のパラメータ
| 名前 | 定義 | コマンドオプション | 説明 |
| startMonitoring | メッセージ削除エラーやリトライキュー内のメッセージ数などのイベントを監視する監視プロセスを開始します。 | -n | NameServerアドレス。形式はip:port |
| -h | ヘルプを表示 |