文档

OnsConsumerAccumulate - 查询消息消费堆积情况

更新时间:
一键部署

查询指定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:QueryConsumerAccumulateRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupIdstring

需查询的消费端 Group ID。

GID_test_consumer_id
Detailboolean

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

  • true:要查询详细信息,返回 DetailInTopicList 参数的详细信息。

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

true
InstanceIdstring

实例 ID。

MQ_INST_111111111111_DOxxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

CE817BFF-B389-43CD-9419-95011AC9****
Dataobject

指定 Consumer 的消费堆积情况。

ConsumeTpsfloat

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

10
DelayTimelong

Group ID 消费消息的最大延迟时间。取值为该 Group ID 订阅的所有 Topic 中,消费延迟时间最长的 Topic 的值。

单位:毫秒。

10000
LastTimestamplong

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

单位:毫秒级的 Unix 时间戳。

1566231000000
TotalDifflong

该 Group ID 订阅的所有 Topic 的消费堆积数量。

100
Onlineboolean

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

  • true:状态为在线

  • false:状态为不在线

true
DetailInTopicListobject []

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

DelayTimelong

该 Topic 中消息消费的最大延迟时间。即 Topic 中最早一条未消费消息的就绪时间和当前的时间差。

单位:毫秒。

10000
TotalDifflong

该 Topic 的消费堆积数量。

100
LastTimestamplong

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

单位:毫秒级的 Unix 时间戳。

1566231000000
Topicstring

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 的消息消费堆积情况。具体操作,请参见查看消费者状态

  • 本页导读 (1)