全部产品
云市场

OnsConsumerTimeSpan

更新时间:2019-08-14 19:36:41

使用 OnsConsumerTimeSpan 查询当前 Group ID 订阅的 Topic 的最新消息时间戳以及消费的最新时间。

描述

使用本接口可以查询某个 Topic 当前服务器上存在的消息的最新时间和最早时间,以及查询消费端最近消费的时间。本接口一般用于展示消费进度的概况,和 OnsConsumerAccumulate 接口配合使用。OnsConsumerAccumulate 接口的详细信息,请参见 OnsConsumerAccumulate

请求参数列表

名称 类型 是否必需 描述
InstanceId String 需查询的消费端 Group ID 所对应的实例 ID
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可,单位毫秒(ms)
GroupId String 需查询的消费端 Group ID
Topic String 需查询的消费端 Group ID 订阅的 Topic

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求的 ID 都是唯一的
HelpUrl String 帮助链接
Data Data 查询结果

Data 数据结构列表

名称 类型 描述
Topic String 需查询的 Topic 名称
MinTimeStamp Long 整个 Topic 目前存储的最新的消息的时间
MaxTimeStamp Long 整个 Topic 目前存储的最早的消息的时间
ConsumeTimeStamp Long 当前 Group 消费该 Topic 的最新的时间

使用示例

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