OnsConsumerStatus - 查詢Group ID消費狀態 -

查詢指定Group ID詳細狀態資料：訂閱關係檢查、消費TPS統計、負載平衡狀態、消費端串連。

介面說明

重要阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。

本介面一般用於在粗略判斷消費堆積以及用戶端線上狀態後，需要排查消費異常原因的情境。可以根據返回結果判斷出指定 Group ID 的訂閱關係是否一致、負載平衡是否正常以及擷取線上用戶端的 Jstack 資訊等。
使用本介面需要調用大量後端介面以完成資料彙總，因此查詢速度慢，不建議頻繁調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryConsumerStatus

get

Group

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

Group

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

無

mq:OnsInstanceBaseInfo

請求參數

名稱	類型	必填	描述	樣本值
GroupId	string	是	需要查詢的消費端 Group 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	否	需查詢的 Group 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
TotalDiff	integer	叢集總的消費堆積。	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	該叢集線上用戶端詳細資料，包含 Jstack、消費 RT 時間等資訊。如需擷取詳細資料，請確保將 Detail 請求參數設定為 true。否則傳回值為空白。
	array<object>	test，此內容不推送到 icms
ConsumeModel	string	消費模型。取值說明如下： CLUSTERING：叢集消費模式 BROADCASTING：廣播消費模式兩種訂閱模式的詳細資料，請參見叢集消費和廣播消費。	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	即時狀態統計。
	object
Rt	number	消費 RT 時間，單位：毫秒。	0
Topic	string	訂閱的 Topic 名稱。	test-mq_topic
FailedCountPerHour	integer	每小時內消費失敗的訊息數統計。	0
OkTps	number	消費訊息成功的 TPS 統計。	0
FailedTps	number	消費訊息失敗的 TPS 統計。	0
SubscriptionSet	object
SubscriptionData	array<object>	訂閱關係集合。
	array<object>
SubString	string	訂閱該 Topic 的子類別 Tag 運算式。	*
SubVersion	integer	訂閱關係版本號碼，為自增 Long 型。	1570701364301
Topic	string	訂閱的 Topic 名稱。	test-mq_topic
TagsSet	object
Tag	array	訂閱的 Tag 集合。
	string	訂閱的 Tag 集合。	ff
Jstack	object
ThreadTrackDo	array<object>	Jstack 堆棧資訊。如需擷取 Jstack 資訊，請確保將 NeedJstack 入參設定為 true。否則傳回值為空白。
	array<object>	test——此內容不發布 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：雲訊息佇列 RocketMQ 版服務端主動向消費者推送訊息。 PULL：消費者主動向雲訊息佇列 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	指定 Group ID 所訂閱的所有 Topic 中的最大消費延時時間。單位：毫秒。	100857
LastTimestamp	integer	最後消費時間。該參數值的格式為毫秒級 Unix 時間戳記。	1566883844954
Online	boolean	是否線上。	true
RebalanceOK	boolean	用戶端 Rebalance 是否正常。取值說明如下： true：正常 false：不正常	true

樣本

正常返回樣本

JSON格式

{
  "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"
        }
      ]
    },
    "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
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。