使用 OnsConsumerAccumulate 查询指定 Group ID 的消息消费堆积情况,包括当前消息堆积数量和消费延迟时间等。

消费堆积查询一般在生产环境中需要关注 Group ID 消费进度时使用,用于粗略判断消息消费情况和延迟情况。您不仅可以查到该 Group ID 订阅的所有 Topic 的消息堆积情况,还可以查到每个 Topic 各自的消息堆积情况。

若您要查看该 Group ID 下各个在线消费者实例的消费信息,请使用 OnsConsumerStatus 接口查询消费状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsConsumerAccumulate

系统规定参数。取值:OnsConsumerAccumulate。

GroupId String GID_test_consumer_id

需查询的消费端 Group ID。

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例 ID。

Detail Boolean true

是否查询各个 Topic 的详细信息。取值说明如下:

  • true:要查询详细信息,返回 DetailInTopicList 参数的详细信息。
  • false:不查询详细信息(默认值),DetailInTopicList 参数返回值为空。

返回数据

名称 类型 示例值 描述
Data Struct

指定 Consumer 的消费堆积情况。

ConsumeTps Float 10

该 Group ID 下消费者实例群组接收消息的总 TPS。

DelayTime Long 10000

延迟时间。

DetailInTopicList Array

各个 Topic 具体情况。如果请求参数 Detail 取值为 fasle,则该返回参数的返回值为空。

DetailInTopicDo
DelayTime Long 10000

该 Topic 中消息消费的最大延迟时间。

LastTimestamp Long 1566231000000

该 Topic 中最近消费的某条消息的生产时间。

Topic String test-mq-topic

Topic 名称。

TotalDiff Long 100

该 Topic 的消费堆积数量。

LastTimestamp Long 1566231000000

该 Group ID 下消费者实例群组中最近消费的某条消息的生产时间。

Online Boolean true

该 Group ID 下是否有消费者实例在线;只要有一个消费者实例在线,该 Group ID 状态即为在线。取值说明如下:

  • true:状态为在线
  • false:状态为不在线
TotalDiff Long 100

所有 Topic 的消费堆积数量。

RequestId String CE817BFF-B389-43CD-9419-95011AC9D5E8

为公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://[Endpoint]/?Action=OnsConsumerAccumulate
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&GroupId=GID_test_consumer_id
&Detail=true
&<公共请求参数>

正常返回示例

XML 格式

<OnsConsumerAccumulateResponse>
  <Data>
        <DetailInTopicList>
              <DetailInTopicDo>
                    <TotalDiff>100</TotalDiff>
                    <LastTimestamp>1566231000000</LastTimestamp>
                    <DelayTime>10000</DelayTime>
                    <Topic>test-mq-topic</Topic>
              </DetailInTopicDo>
        </DetailInTopicList>
        <TotalDiff>100</TotalDiff>
        <LastTimestamp>1566231000000</LastTimestamp>
        <DelayTime>10000</DelayTime>
        <Online>true</Online>
        <ConsumeTps>10</ConsumeTps>
  </Data>
  <RequestId>0CCF6437-CBB0-4378-BFEC-E08AC2583589</RequestId>
</OnsConsumerAccumulateResponse>

JSON 格式

{
  "Data": {
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "TotalDiff": 100,
          "LastTimestamp": 1566231000000,
          "DelayTime": 10000,
          "Topic": "test-mq-topic"
        }
      ]
    },
    "TotalDiff": 100,
    "LastTimestamp": 1566231000000,
    "DelayTime": 10000,
    "Online": true,
    "ConsumeTps": 10
  },
  "RequestId": "0CCF6437-CBB0-4378-BFEC-E08AC2583589"
}

错误码

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