用于粗略判断消息消费情况和延迟情况。

调试

您可以在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"
}

错误码

访问错误中心查看更多错误码。