全部产品
云市场

OnsConsumerAccumulate

更新时间:2019-08-14 15:52:08

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

描述

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

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

请求参数列表

名称 类型 是否必需 描述
InstanceId String 需查询的 Group ID 所对应的实例 ID
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可,单位毫秒(ms)
GroupId String 需查询的消费端 Group ID
Detail Boolean 是否查询详细信息。取值说明如下:
  • true:要查询详细信息
  • false:不查询详细信息(默认值)

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求的 ID 都是唯一的
HelpUrl String 帮助链接
Data Data 指定 Consumer 的消费堆积情况

Data 数据结构列表

名称 类型 描述
OnLine Boolean 该 Group ID 下是否有消费者实例在线;只要有一个消费者实例在线,该 Group ID 状态即为在线。取值说明如下:
  • true:状态为在线
  • false:状态为不在线
TotalDiff Long 当前 Group ID 订阅的所有 Topic 的消息总堆积数量
ConsumeTps Float 该 Group ID下消费者实例群组接收消息的总 TPS
LastTimestamp Long 该 Group ID 下消费者实例群组中最近消费的那条信息的生产时间
DelayTime Long 该 Group ID 下消费者实例群组中消息消费的最大延迟时间
DetailInTopicList List(OnsConsumerAccumulateResponse.Data.DetailInTopicDo) 各个 Topic 具体情况

DetailInTopicList 数据结构列表

名称 类型 描述
Topic String Topic 名称
TotalDiff Long 该 Topic 的消费堆积数量
LastTimestamp Long 该 Topic 中最近一条被消费的信息的生产时间
DelayTime Long 该 Topic 所发消息的最大消费延迟时间

使用示例

示例代码请参见管控 API 示例代码和接入点列表