使用OnsConsumerAccumulate查詢訊息堆積數量和消費延遲-雲訊息佇列 RocketMQ 版-阿里雲

查詢指定Group ID的訊息消費堆積情況，包括當前訊息堆積數量和消費延遲時間等。

介面說明

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

消費堆積查詢一般在生產環境中需要關注 Group ID 消費進度時使用，用於粗略判斷訊息消費情況和延遲情況。您不僅可以查到該 Group ID 訂閱的所有 Topic 的訊息堆積情況，還可以查到每個 Topic 各自的訊息堆積情況。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryConsumerAccumulate

get

Group

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

Group

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

無

mq:OnsInstanceBaseInfo

請求參數

名稱	類型	必填	描述	樣本值
GroupId	string	是	需查詢的消費端 Group ID。	GID_test_consumer_id
Detail	boolean	否	是否查詢各個 Topic 的詳細資料。取值說明如下： true：要查詢詳細資料，返回 DetailInTopicList 參數的詳細資料。 false：不查詢詳細資料（預設值），DetailInTopicList 參數傳回值為空白。	true
InstanceId	string	否	執行個體 ID。	MQ_INST_111111111111_DOxxxxxx

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	指定 Consumer 的消費堆積情況。
ConsumeTps	number	該 Group ID 下消費者執行個體群組接收訊息的總 TPS。	10
DelayTime	integer	Group ID 消費訊息的最大延遲時間。取值為該 Group ID 訂閱的所有 Topic 中，消費延遲時間最長的 Topic 的值。單位：毫秒。	10000
LastTimestamp	integer	該 Group ID 下消費者執行個體群組中最近消費的某條訊息的生產時間。單位：毫秒級的 Unix 時間戳記。	1566231000000
TotalDiff	integer	該 Group ID 訂閱的所有 Topic 的消費堆積數量。	100
Online	boolean	該 Group ID 下是否有消費者執行個體線上；只要有一個消費者執行個體線上，該 Group ID 狀態即為線上。取值說明如下： true：狀態為線上 false：狀態為不線上	true
DetailInTopicList	object
DetailInTopicDo	array<object>	各個 Topic 具體情況。如果請求參數 Detail 取值為 fasle，則該返回參數的傳回值為空白。
	object
DelayTime	integer	該 Topic 中訊息消費的最大延遲時間。即 Topic 中最早一條未消費訊息的就緒時間和當前的時間差。單位：毫秒。	10000
TotalDiff	integer	該 Topic 的消費堆積數量。	100
LastTimestamp	integer	該 Topic 中最近消費的某條訊息的生產時間。單位：毫秒級的 Unix 時間戳記。	1566231000000
Topic	string	Topic 名稱。	test-mq-topic

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CE817BFF-B389-43CD-9419-95011AC9****",
  "Data": {
    "ConsumeTps": 10,
    "DelayTime": 10000,
    "LastTimestamp": 1566231000000,
    "TotalDiff": 100,
    "Online": true,
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 10000,
          "TotalDiff": 100,
          "LastTimestamp": 1566231000000,
          "Topic": "test-mq-topic"
        }
      ]
    }
  }
}

錯誤碼

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

變更歷史

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