全部产品
云市场

OnsMessageGetByKey

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

使用 OnsMessageGetByKey 通过传入 Topic 名称和 Message Key 进行模糊查询,得到符合条件的消息的信息列表。

描述

使用本接口根据 Message Key 查询消息的方式属于模糊查询。由于业务方的 Key 可能不唯一,所以查询结果可能为多条。

本接口用在业务方无法获取 Message ID 的场景,在该场景下的调用步骤如下所示:

  1. 调用本接口模糊查询得到 Message ID 列表。

  2. 调用 OnsMessageGetByMsgId 接口精确查询。OnsMessageGetByMsgId 接口的详细信息,请参见OnsMessageGetByMsgId

请求参数列表

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

返回参数列表

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

OnsRestMessageDo 数据结构列表

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

使用示例

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