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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsTraceQueryByMsgKey

系统规定参数。取值:OnsTraceQueryByMsgKey。

BeginTime Long 1570852800

查询的时间范围的起始时间点

EndTime Long 1570968000

查询的时间范围的结束时间点

MsgKey String ORDERID_100

需查询的消息的 Message Key

Topic String test

需查询的消息的 Topic

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查询的消息的 Topic 所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。

返回数据

名称 类型 示例值 描述
QueryId String 272967562652883649157096685****

该查询任务的 ID,根据该任务 ID 再调用 OnsTraceGetResult 接口获取详细结果

RequestId String F8654231-122A-4DBD-801F-38E3553851A8

为公共参数,每个请求的 ID 都是唯一的

示例

请求示例


http(s)://[Endpoint]/?Action=OnsTraceQueryByMsgKey
&BeginTime=1570852800
&EndTime=1570968000
&MsgKey=ORDERID_100
&Topic=test
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<OnsTraceQueryByMsgKeyResponse>
  <RequestId>F8654231-122A-4DBD-801F-38E3553851A8</RequestId>
  <QueryId>272967562652883649157096685****</QueryId>
</OnsTraceQueryByMsgKeyResponse>

JSON 格式

{
	"RequestId":"F8654231-122A-4DBD-801F-38E3553851A8",
	"QueryId":"272967562652883649157096685****"
}

错误码

访问错误中心查看更多错误码。