OnsConsumerStatus - - Alibaba Cloud ドキュメントセンター

この操作では、指定されたグループ ID の詳細なステータスデータをクエリします。これには、サブスクリプション関係のチェック、消費 TPS 統計、ロードバランシングの状態、およびコンシューマー側の接続情報が含まれます。

操作説明

重要 Alibaba Cloud OpenAPI は管理用 API であり、Alibaba Cloud リソースの管理およびクエリに使用されます。管理ワークフローでのみ使用し、メッセージのパブリッシュまたはコンシュームのコアワークフローでは OpenAPI に依存しないでください。そうすることでリスクが生じる可能性があります。

メッセージの蓄積やクライアントのオンライン状態を確認した後、この操作を使用して異常なコンシュームをトラブルシューティングできます。応答により、指定されたグループ ID のサブスクリプション関係の一貫性を検証し、ロードバランシングが正常であることを確認し、オンラインクライアントの Jstack 情報を取得できます。
この操作は多くのバックエンドインターフェイスを呼び出してデータを集約するため、実行に時間がかかる場合があります。そのため、頻繁な呼び出しは避けてください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:QueryConsumerStatus

get

Group

acs:mq:{#regionId}:{#accountId}:{#GroupName}

Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	クエリ対象のコンシューマーのグループ ID です。	GID_test_group_id
Detail	boolean	任意	詳細情報を返すかどうかを指定します。有効な値は以下のとおりです。 true：詳細情報を返します。ConsumerConnectionInfoList および DetailInTopicList を含みます。 false：デフォルト値です。詳細情報を返しません。ConsumerConnectionInfoList および DetailInTopicList は空になります。	true
NeedJstack	boolean	任意	Jstack 情報を出力するかどうかを指定します。有効な値は以下のとおりです。 true：Jstack 情報を出力します。Jstack 応答フィールドからスタックトレースを取得できます。説明 Jstack 情報を出力するには、Detail リクエストパラメーターを true に設定する必要があります。 false：デフォルト値です。Jstack 情報を出力しません。Jstack 応答フィールドは空になります。	true
InstanceId	string	任意	クエリ対象のグループ ID に関連付けられたインスタンス ID です。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	共通パラメーターです。各リクエストには一意の ID が割り当てられます。問題の特定およびトラブルシューティングに使用します。	10EDC518-10E7-4B34-92FB-171235FA****
Data	object	クエリ結果です。
ConsumeTps	number	合計消費 TPS です。	0
ConsumeModel	string	消費モデルです。有効な値は以下のとおりです。 CLUSTERING：クラスタリング消費モード BROADCASTING：ブロードキャスト消費モードこれらのサブスクリプションモードの詳細については、「クラスタリングおよびブロードキャスト消費」をご参照ください。	CLUSTERING
ConnectionSet	object
ConnectionDo	array<object>	クラスター内で現在オンラインのクライアントに関する情報です。
	object
RemoteIP	string	ホスト IP アドレスまたはパブリック IP アドレスです。	42.120.74.**
Version	string	コンシューマーバージョンです。	V4_3_6_SNAPSHOT
ClientAddr	string	コンシューマーインスタンスのアドレスおよびポートです。	30.5.121.**
Language	string	コンシューマー言語です。	JAVA
ClientId	string	コンシューマーインスタンスの ID です。	30.5.121.**@25560#-1999745829#-1737591554#458773089270275
Diff	integer		100
TotalDiff	integer	クラスター全体のメッセージ蓄積量の合計です。	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	クラスター内のオンラインクライアントに関する詳細情報（Jstack や消費 RT など）です。Detail リクエストパラメーターを true に設定すると取得できます。それ以外の場合、応答は空になります。
	array<object>	test, this content is not published to ICMS
ConsumeModel	string	消費モデルです。有効な値は以下のとおりです。 CLUSTERING：クラスタリング消費モード BROADCASTING：ブロードキャスト消費モードこれらのサブスクリプションモードの詳細については、「クラスタリングおよびブロードキャスト消費」をご参照ください。	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	リアルタイムのステータス統計です。
	object
Rt	number	消費応答時間 (RT) です。単位はミリ秒です。	0
Topic	string	サブスクライブしている Topic の名前です。	test-mq_topic
FailedCountPerHour	integer	1 時間に消費に失敗したメッセージ数です。	0
OkTps	number	正常に消費されたメッセージの TPS です。	0
FailedTps	number	消費に失敗したメッセージの TPS です。	0
SubscriptionSet	object
SubscriptionData	array<object>	サブスクリプション関係のコレクションです。
	array<object>
SubString	string	Topic をサブスクライブするために使用されるタグ式です。	*
SubVersion	integer	サブスクリプション関係のバージョン番号です。これは自動的に増分される long 型整数です。	1570701364301
Topic	string	サブスクライブしている Topic の名前です。	test-mq_topic
TagsSet	object
Tag	array	サブスクライブされているタグのコレクションです。
	string	サブスクライブされているタグのコレクションです。	ff
Jstack	object
ThreadTrackDo	array<object>	Jstack スタックトレースです。NeedJstack リクエストパラメーターを true に設定すると取得できます。それ以外の場合、応答は空になります。
	array<object>	test—this content is not published to ICMS
TrackList	object
Track	array	Jstack スタックトレース文字列です。
	string	Jstack スタックトレース文字列です。	TID: 52 STATE: WAITING
Thread	string	スレッド名です。	ConsumeMessageThread_0
LastTimeStamp	integer	最終消費のタイムスタンプです。この値はミリ秒単位の UNIX タイムスタンプを使用します。	1570701368114
StartTimeStamp	integer	消費開始時のタイムスタンプです。この値はミリ秒単位の UNIX タイムスタンプを使用します。	1570701361528
Language	string	クライアント言語です。	JAVA
ClientId	string	コンシューマーインスタンスの ID です。	30.5..@25560#-1999745829#-1737591554#458773089270275
Connection	string	接続情報です。	**
Version	string	クライアントのバージョン番号です。	V4_3_6
ConsumeType	string	メッセージ消費モードです。有効な値は以下のとおりです。 PUSH：ApsaraMQ for RocketMQ がコンシューマーにメッセージをプッシュします。 PULL：コンシューマーが ApsaraMQ for RocketMQ からメッセージをプルします。	PUSH
ThreadCount	integer	消費スレッド数です。	20
InstanceId	string	インスタンス ID です。	MQ_INST_111111111111_DOxxxxxx
DetailInTopicList	object
DetailInTopicDo	array<object>	各 Topic の消費詳細です。Detail リクエストパラメーターを true に設定すると取得できます。それ以外の場合、応答は空になります。
	object
DelayTime	integer	指定された Topic の消費遅延時間です。単位はミリ秒です。	0
TotalDiff	integer	Topic のメッセージ蓄積量の合計です。	0
LastTimestamp	integer	最終消費のタイムスタンプです。この値はミリ秒単位の UNIX タイムスタンプを使用します。	1570701259403
Topic	string	Topic 名です。	test-mq_topic
SubscriptionSame	boolean	サブスクリプション関係が一貫しているかどうかを示します。	true
DelayTime	integer	指定されたグループ ID がサブスクライブしているすべての Topic における最大消費遅延時間です。単位はミリ秒です。	100857
LastTimestamp	integer	最終消費のタイムスタンプです。この値はミリ秒単位の UNIX タイムスタンプを使用します。	1566883844954
Online	boolean	クライアントがオンラインかどうかを示します。	true
RebalanceOK	boolean	リバランスが正常かどうかを示します。有効な値は以下のとおりです。 true：正常 false：異常	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "10EDC518-10E7-4B34-92FB-171235FA****",
  "Data": {
    "ConsumeTps": 0,
    "ConsumeModel": "CLUSTERING",
    "ConnectionSet": {
      "ConnectionDo": [
        {
          "RemoteIP": "42.120.74.**",
          "Version": "V4_3_6_SNAPSHOT",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@25560#-1999745829#-1737591554#458773089270275",
          "Diff": 100
        }
      ]
    },
    "TotalDiff": 197,
    "ConsumerConnectionInfoList": {
      "ConsumerConnectionInfoDo": [
        {
          "ConsumeModel": "CLUSTERING",
          "RunningDataList": {
            "ConsumerRunningDataDo": [
              {
                "Rt": 0,
                "Topic": "test-mq_topic",
                "FailedCountPerHour": 0,
                "OkTps": 0,
                "FailedTps": 0
              }
            ]
          },
          "SubscriptionSet": {
            "SubscriptionData": [
              {
                "SubString": "*",
                "SubVersion": 1570701364301,
                "Topic": "test-mq_topic",
                "TagsSet": {
                  "Tag": [
                    "ff"
                  ]
                }
              }
            ]
          },
          "Jstack": {
            "ThreadTrackDo": [
              {
                "TrackList": {
                  "Track": [
                    "TID: 52 STATE: WAITING"
                  ]
                },
                "Thread": "ConsumeMessageThread_0"
              }
            ]
          },
          "LastTimeStamp": 1570701368114,
          "StartTimeStamp": 1570701361528,
          "Language": "JAVA",
          "ClientId": "30.5.**.**@25560#-1999745829#-1737591554#458773089270275",
          "Connection": "**",
          "Version": "V4_3_6",
          "ConsumeType": "PUSH",
          "ThreadCount": 20
        }
      ]
    },
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 0,
          "TotalDiff": 0,
          "LastTimestamp": 1570701259403,
          "Topic": "test-mq_topic"
        }
      ]
    },
    "SubscriptionSame": true,
    "DelayTime": 100857,
    "LastTimestamp": 1566883844954,
    "Online": true,
    "RebalanceOK": true
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。