全部产品
云市场

OnsTraceGetResult

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

使用 OnsTraceGetResult 通过传入轨迹查询任务的 ID 获取之前的轨迹查询结果。

描述

业务方已经根据 Message ID 或者 Message Key 创建了轨迹查询任务,并得到了查询任务的 ID。您可调用本接口根据该任务 ID 获取对应的轨迹结果的明细。

因为消息轨迹查询任务耗时较多,创建任务后立即根据该接口获取结果可能为空,若遇到此情况,建议等待一段时间再重试。

请求参数列表

名称 类型 是否必需 描述
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可,单位毫秒(ms)
QueryId String 需要提取轨迹查询结果的任务 ID

返回参数列表

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

TraceData 数据结构列表

名称 类型 描述
queryId String 查询任务 ID
userId String 查询用户 ID
topic String 该查询任务的 Topic
msgId String 该查询任务对应的 Message ID
msgKey String 该查询任务对应的 Message Key
status String 该查询任务的结果。取值说明如下:
  • finish:查询完成
  • working:查询中
  • removed:任务已删除
createTime Long 该查询任务的创建时间
updateTime Long 该查询任务的最后更新时间
traceList List(TraceMapDo) 该查询任务的匹配轨迹列表

TraceMapDo 数据结构

名称 类型 描述
pubTime Long 消息发送时间
topic String 消息的 Topic
pubGroupName String 发送方客户端配置的 Group ID
msgId String 消息的 ID,即 Message ID
tag String 消息的 Tag,即 Message Tag
msgKey String 消息的 Key ,即 Message Key
bornHost String 消息发送方的客户端地址
costTime Integer 发送耗时,单位毫秒
status String 发送状态。取值说明如下:
  • SEND_SUCCESS:发送成功
  • SEND_FAILED:发送失败
  • SEND_ROLLBACK:事务消息回滚
  • SEND_UNKNOWN:事务消息未提交
  • SEND_DELAY:定时(延时)消息定时中
subList List(SubMapDo) 消息的消费轨迹列表

SubMapDo 数据结构列表

名称 类型 描述
subGroupName String 消费方 Group ID
successCount Integer 该 Group ID 消费成功次数统计
failCount Integer 该 Group ID 消费失败次数统计
clientList List(SubClientInfoDo) 该 Group ID 客户端消费记录的明细列表

SubClientInfoDo 数据结构列表

名称 类型 描述
subGroupName String 该客户端所属的 Group ID
subTime Long 消费开始时间戳
clientHost String 消费客户端的客户端地址
reconsumeTimes Integer 本次消费的投递轮次
costTime Integer 本次消费耗时,单位毫秒
status String 消费状态。取值说明如下:
  • CONSUME_FAILED:消费失败
  • CONSUME_SUCCESS:消费成功
  • CONSUME_NOT_RETURN:消费未返回结果
  • SEND_UNKNOWN:事务消息未提交
  • SEND_DELAY:定时(延时)消息定时中

使用示例

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