全部产品
云市场

OnsMessageGetByMsgId

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

使用 OnsMessageGetByMsgId 通过传入 Message ID 查询指定消息的信息以及判断该指定的消息是否曾被消费过。查询到的信息包括发送时间、存储服务器和消息的 Key 和 Tag 等属性。

描述

根据 Message ID 查询消息的方式属于精确查询,查询条件需要的 Message ID 从每次消息发送成功的 SendResult 中获取,因此业务方必须存储每次发送消息的结果。

请求参数列表

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

返回参数列表

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

Data 数据结构列表

名称 类型 描述
Topic String 消息的 Topic
PropertyList List(MessageProperty) 消息属性列表
Body String 消息体
StoreSize Integer 消息大小
BornTimestamp Long 生成时间戳
BornHost String 生成该消息的客户端实例
StoreTimestamp Long 被服务端存储的时间戳
StoreHost String 存储该消息的服务器实例
MsgId String 消息 ID,即 Message ID
BodyCRC Integer 消息体 CRC 校验值
ReconsumeTimes Integer 消息重试消费的次数

使用示例

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