调用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	Read	Ons acs:mq:{#regionId}:{#accountId}:{#GroupName} Ons acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}	无	无

请求参数

名称	类型	必填	描述	示例值
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	float	该Group ID下消费者实例群组接收消息的总TPS。	10
DelayTime	long	Group ID消费消息的最大延迟时间。取值为该Group ID订阅的所有Topic中，消费延迟时间最长的Topic的值。单位：毫秒。	10000
LastTimestamp	long	该Group ID下消费者实例群组中最近消费的某条消息的生产时间。单位：毫秒级的Unix时间戳。	1566231000000
TotalDiff	long	该Group ID订阅的所有Topic的消费堆积数量。	100
Online	boolean	该Group ID下是否有消费者实例在线；只要有一个消费者实例在线，该Group ID状态即为在线。取值说明如下： true：状态为在线 false：状态为不在线	true
DetailInTopicList	object []	各个Topic具体情况。如果请求参数Detail取值为fasle，则该返回参数的返回值为空。
DelayTime	long	该Topic中消息消费的最大延迟时间。即Topic中最早一条未消费消息的就绪时间和当前的时间差。单位：毫秒。	10000
TotalDiff	long	该Topic的消费堆积数量。	100
LastTimestamp	long	该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"
        }
      ]
    }
  }
}

错误码

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

控制台操作

除了调用OnsConsumerAccumulate接口，您还可以通过云消息队列 RocketMQ 版控制台查看Group ID的消息消费堆积情况。具体操作，请参见查看消费者状态。