全部产品
云市场

OnsTraceQueryByMsgKey

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

使用 OnsTraceQueryByMsgKey 通过传入 Topic 名称和 Message Key 创建轨迹查询任务,得到该查询任务的 ID。

描述

业务方记录了 Message Key ,并需要根据此 Message Key 查询该消息的投递轨迹信息,即可使用 OnsTraceQueryByMsgKey 接口创建查询任务。该接口返回任务 ID 后 ,再根据 OnsTraceGetResult 接口传入任务 ID 即可获取查询结果。OnsTraceGetResult 接口的详细信息,请参见 OnsTraceGetResult

请求参数列表

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

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求的 ID 都是唯一的
HelpUrl String 帮助链接
QueryId String 该查询任务的 ID,根据该任务 ID 再调用 OnsTraceGetResult 接口获取详细结果

使用示例

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