使用GetConsumerGroupLag查詢消費者組堆積資訊-雲訊息佇列 RocketMQ 版-阿里雲

查詢消費者組堆積資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:GetConsumerGroupLag

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

無

請求文法

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/lag HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	rmq-cn-2r42vrvde0j
consumerGroupId	string	是	消費者分組 ID。	CID-TEST

請求參數

名稱	類型	必填	描述	樣本值
topicName	string	否	消費者分組訂閱的主題名稱。	normal-topic-1
liteTopicName	string	否	輕量主題名稱	abc

返回參數

名稱	類型	描述	樣本值
	object	Result
requestId	string	請求 ID	F5764C40-FB8C-53AE-B95D-96AB3D0E9375
success	boolean	是否成功	true
data	object	返回結果
regionId	string	地區 ID	cn-hangzhou
instanceId	string	執行個體 ID	rmq-cn-7e22ody****
consumerGroupId	string	消費組 ID	CID-TEST
totalLag	object	整體堆積量
readyCount	integer	就緒訊息量	1
inflightCount	integer	處理中訊息量	1
deliveryDuration	integer	投遞延遲時間，單位：秒	12
lastConsumeTimestamp	integer	最新消費時間	1735629607846
topicLagMap	object	各主題堆積量
	object	整體訊息量
readyCount	integer	就緒訊息量	1
inflightCount	integer	處理中訊息量	1
deliveryDuration	integer	投遞延遲時間，單位：秒	12
lastConsumeTimestamp	integer	最新消費時間	1735629607846
topicName	string	訂閱的 topic 名稱	test1
liteTopicLagMap	object	輕量主題的消費堆積
	object	lite 類型 topic 的消費堆積
readyCount	integer	堆積訊息量	300
deliveryDuration	integer	投遞延遲時間，單位：秒	30
code	string	錯誤碼	Topic.NotFound
message	string	錯誤資訊	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 狀態代碼	200
dynamicCode	string	動態錯誤碼	InstanceId
dynamicMessage	string	動態錯誤資訊	instanceId

樣本

正常返回樣本

JSON格式

{
  "requestId": "F5764C40-FB8C-53AE-B95D-96AB3D0E9375",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "totalLag": {
      "readyCount": 1,
      "inflightCount": 1,
      "deliveryDuration": 12,
      "lastConsumeTimestamp": 1735629607846
    },
    "topicLagMap": {
      "key": {
        "readyCount": 1,
        "inflightCount": 1,
        "deliveryDuration": 12,
        "lastConsumeTimestamp": 1735629607846
      }
    },
    "topicName": "test1",
    "liteTopicLagMap": {
      "key": {
        "readyCount": 300,
        "deliveryDuration": 30
      }
    }
  },
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

錯誤碼

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

變更歷史

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