全部产品

OnsMessageTrace

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

使用 OnsMessageTrace 根据 Message ID 来判断目标消息是否曾被消费过。

描述

本接口的实现基于消息队列 RocketMQ 的内部位点机制,在大部分场景下判断结果可信,但如果应用方进行过重置位点已经清除消息等操作,则判断结果可能有误。

请求参数列表

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

返回参数列表

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

MessageTrack 数据结构列表

名称 类型 描述
ConsumerGroup String 消费集群名称
TrackType String 当前状态。取值如下
  • CONSUMED:已消费
  • CONSUMED_BUT_FILTERED:已被过滤
  • NOT_CONSUME_YET:暂未消费
  • NOT_ONLINE:客户端不在线
  • UNKNOWN:其他问题
ExceptionDesc String 异常描述

使用示例

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