用于粗略判斷消息消費情況和延遲情況。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 QueryMqSofamqConsumerAccumulate

系統規定參數。取值：QueryMqSofamqConsumerAccumulate。
Cell String 否 RZ01A

需要查詢的 Group ID 所在的單元
Detail Boolean 否 true

是否查詢詳細信息。取值說明如下：true：要查詢詳細信息；false：不查詢詳細信息（默認值）。
GroupId String 是 GID_test_consumer_id

需查詢的消費端 Group ID
InstanceId String 是 MQ_INST_111111111111_DOxxxxxx

實例 ID。針對有獨立命名空間的實例，該參數為必填。

返回數據

名稱 類型 示例值 描述
ResultMessage String OK

結果描述
ResultCode String OK

結果碼
RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

請求ID
Data Object

指定 Consumer 的消費堆積情況
ConsumeTps String 10

該 Group ID 下消費者實例群組接收消息的總 TPS，單位：條/秒。
TotalDiff Long 100

該 Topic 的消費堆積數量
LastTimestamp Long 1566231000000

該 Topic 中最近一條被消費的信息的生產時間，單位：毫秒。
DelayTime Long 10000

該 Topic 所發消息的最大消費延遲時間，單位：毫秒。
Online Boolean true

該 Group ID 下是否有消費者實例在線；只要有一個消費者實例在線，該 Group ID 狀態即為在線。取值說明如下：

  • true：狀態為在線。
  • false：狀態為不在線。
DetailInTopicList Array of DetailInTopicList

各個 Topic 具體情況
TotalDiff Long 0

該 Topic 消費總堆積數
DelayTime Long 0

延遲時間，單位：毫秒。
LastTimestamp Long 1570701259403

最后更新時間，單位：毫秒。
Topic String test-mq_topic

Topic 名稱

示例

請求示例

http(s)://[Endpoint]/?Action=QueryMqSofamqConsumerAccumulate
&GroupId=GID_test_consumer_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共請求參數>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <ConsumeTps>10</ConsumeTps>
    <LastTimestamp>1566231000000</LastTimestamp>
    <TotalDiff>100</TotalDiff>
    <DelayTime>10000</DelayTime>
    <Online>true</Online>
    <DetailInTopicList>
        <LastTimestamp>1570701259403</LastTimestamp>
        <TotalDiff>0</TotalDiff>
        <DelayTime>0</DelayTime>
        <Topic>test-mq_topic</Topic>
    </DetailInTopicList>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "861E6630-AEC0-4B2D-B214-6CB5E44B7F04",
  "Data" : {
    "ConsumeTps" : "10",
    "LastTimestamp" : "1566231000000",
    "TotalDiff" : "100",
    "DelayTime" : "10000",
    "Online" : "true",
    "DetailInTopicList" : [ {
      "LastTimestamp" : "1570701259403",
      "TotalDiff" : "0",
      "DelayTime" : "0",
      "Topic" : "test-mq_topic"
    } ]
  },
  "ResultMessage" : "OK",
  "ResultCode" : "OK"
}

錯誤碼

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