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

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

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

调试

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

请求参数

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

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

QueryId String 272967562652883649157096685****

需要提取轨迹查询结果的任务 ID

返回数据

名称 类型 示例值 描述
RequestId String 84EE24D2-851F-40D6-B99E-4D6AB9098BC4

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

TraceData

该查询任务的结果明细

CreateTime Long 1570966857000

该查询任务的创建时间

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例 ID

MsgId String 1E05791C117818B4AAC23B1BB0CE****

该查询任务对应的 Message ID

MsgKey String ORDERID_100

该查询任务对应的 Message Key

QueryId String 272967562652883649157096685****

查询任务 ID

Status String finish

该查询任务的结果。取值说明如下:

  • finish:查询完成
  • working:查询中
  • removed:任务已删除
Topic String test

该查询任务的 Topic

TraceList Array

该查询任务的匹配轨迹列表

TraceMapDo

该查询任务的匹配轨迹列表

BornHost String 30.5.**.**

消息发送方的客户端地址

CostTime Integer 24

发送耗时,单位毫秒

MsgId String 0BC1F01800002A9F000000531246****

消息的 ID,即 Message ID

MsgKey String ORDERID_100

消息的 Key ,即 Message Key

PubGroupName String GID_test

发送方客户端配置的 Group ID

PubTime Long 1570850870478

消息发送时间

Status String SEND_SUCCESS

发送状态。取值说明如下:

  • SEND_SUCCESS:发送成功
  • SEND_FAILED:发送失败
  • SEND_ROLLBACK:事务消息回滚
  • SEND_UNKNOWN:事务消息未提交
  • SEND_DELAY:定时(延时)消息定时中
SubList Array

消息的消费轨迹列表

SubMapDo

消息的消费轨迹列表

ClientList Array

该 Group ID 客户端消费记录的明细列表

SubClientInfoDo

该 Group ID 客户端消费记录的明细列表

ClientHost String 30.5.**.**

消费客户端的客户端地址

CostTime Integer 43

本次消费耗时,单位毫秒

ReconsumeTimes Integer 1

本次消费的投递轮次

Status String CONSUME_SUCCESS

消费状态。取值说明如下:

  • CONSUME_FAILED:消费失败
  • CONSUME_SUCCESS:消费成功
  • CONSUME_NOT_RETURN:消费未返回结果
  • SEND_UNKNOWN:事务消息未提交
  • SEND_DELAY:定时(延时)消息定时中
SubGroupName String GID_test

该客户端所属的 Group ID

SubTime Long 1570851590511

消费开始时间戳

FailCount Integer 0

该 Group ID 消费失败次数统计

SubGroupName String GID_test

消费方 Group ID

SuccessCount Integer 1

该 Group ID 消费成功次数统计

Tag String TagA

消息的 Tag,即 Message Tag

Topic String test

消息的 Topic

UpdateTime Long 1570966877000

该查询任务的最后更新时间

UserId String 27296756265288****

查询用户 ID

示例

请求示例


http(s)://[Endpoint]/?Action=OnsTraceGetResult
&QueryId=272967562652883649157096685****
&<公共请求参数>

正常返回示例

XML 格式

<OnsTraceGetResultResponse>
  <TraceData>
        <MsgId>1E05791C117818B4AAC23B1BB0CE****</MsgId>
        <Status>finish</Status>
        <TraceList>
              <TraceMapDo>
                    <BornHost>30.5.**.**</BornHost>
                    <MsgId>0BC1F01800002A9F000000531246****</MsgId>
                    <Status>SEND_SUCCESS</Status>
                    <CostTime>24</CostTime>
                    <PubTime>1570850870478</PubTime>
                    <Tag>TagA</Tag>
                    <Topic>test</Topic>
                    <MsgKey>ORDERID_100</MsgKey>
                    <PubGroupName>GID_test</PubGroupName>
                    <SubList>
                          <SubMapDo>
                                <ClientList>
                                      <SubClientInfoDo>
                                            <Status>CONSUME_SUCCESS</Status>
                                            <CostTime>43</CostTime>
                                            <ClientHost>30.5.**.**</ClientHost>
                                            <ReconsumeTimes>1</ReconsumeTimes>
                                            <SubTime>1570851590511</SubTime>
                                            <SubGroupName>GID_test</SubGroupName>
                                      </SubClientInfoDo>
                                </ClientList>
                                <SuccessCount>1</SuccessCount>
                                <FailCount>0</FailCount>
                                <SubGroupName>GID_test</SubGroupName>
                          </SubMapDo>
                    </SubList>
              </TraceMapDo>
        </TraceList>
        <CreateTime>1570966857000</CreateTime>
        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
        <Topic>test</Topic>
        <UpdateTime>1570966877000</UpdateTime>
        <QueryId>272967562652883649157096685****</QueryId>
        <UserId>27296756265288****</UserId>
  </TraceData>
  <RequestId>84EE24D2-851F-40D6-B99E-4D6AB9098BC4</RequestId>
</OnsTraceGetResultResponse>

JSON 格式

{
	"TraceData":{
		"MsgId":"1E05791C117818B4AAC23B1BB0CE****",
		"Status":"finish",
		"TraceList":{
			"TraceMapDo":[
				{
					"MsgId":"0BC1F01800002A9F000000531246****",
					"BornHost":"30.5.**.**",
					"CostTime":24,
					"Status":"SEND_SUCCESS",
					"PubTime":1570850870478,
					"Tag":"TagA",
					"Topic":"test",
					"PubGroupName":"GID_test",
					"MsgKey":"ORDERID_100",
					"SubList":{
						"SubMapDo":[
							{
								"SuccessCount":1,
								"ClientList":{
									"SubClientInfoDo":[
										{
											"CostTime":43,
											"Status":"CONSUME_SUCCESS",
											"ClientHost":"30.5.**.**",
											"SubTime":1570851590511,
											"ReconsumeTimes":1,
											"SubGroupName":"GID_test"
										}
									]
								},
								"SubGroupName":"GID_test",
								"FailCount":0
							}
						]
					}
				}
			]
		},
		"InstanceId":"MQ_INST_111111111111_DOxxxxxx",
		"CreateTime":1570966857000,
		"Topic":"test",
		"UpdateTime":1570966877000,
		"UserId":"27296756265288****",
		"QueryId":"272967562652883649157096685****"
	},
	"RequestId":"84EE24D2-851F-40D6-B99E-4D6AB9098BC4"
}

错误码

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