全部产品
Search

搜索本产品

    云消息队列 RocketMQ 版：OnsConsumerAccumulate - 查询消息消费堆积情况

    文档中心

    云消息队列 RocketMQ 版：OnsConsumerAccumulate - 查询消息消费堆积情况

    更新时间：Oct 23, 2024

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

    接口说明

    注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。
    消费堆积查询一般在生产环境中需要关注 Group ID 消费进度时使用，用于粗略判断消息消费情况和延迟情况。您不仅可以查到该 Group ID 订阅的所有 Topic 的消息堆积情况，还可以查到每个 Topic 各自的消息堆积情况。

    调试

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

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    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
    DetailInTopicListarray<object>

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

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