通过传入轨迹查询任务的ID获取之前的轨迹查询结果。
接口说明
若您已根据 Message ID 或者 Message Key 创建了轨迹查询任务,并得到了查询任务的 ID。您可调用本接口根据查询任务 ID 获取对应的轨迹结果的明细。轨迹查询任务通过 OnsTraceQueryByMsgId 或 OnsTraceQueryByMsgKey 接口创建,返回数据中的 QueryId 即为本接口中需要传入的查询任务 ID。
因为消息轨迹查询任务耗时较多,创建任务后立即根据该接口获取结果可能为空,若遇到此情况,建议等待一段时间再重试。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mq:GetTraceResult |
get |
*Topic
*Topic
|
无 |
|
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| QueryId |
string |
是 |
需要提取轨迹查询结果的任务 ID。 |
272967562652883649157096685**** |
| InstanceId |
string |
否 |
需查询的消息所对应的实例 ID。 |
MQ_INST_111111111111_DOxxxxxx |
| Topic |
string |
否 |
需查询的消息的 Topic。 |
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。 |
84EE24D2-851F-40D6-B99E-4D6AB909**** |
| TraceData |
object |
该查询任务的结果明细。 |
|
| Status |
string |
该查询任务的结果。取值说明如下:
|
finish |
| MsgKey |
string |
该查询任务对应的 Message Key。 |
ORDERID_100 |
| UpdateTime |
integer |
该查询任务的最后更新时间。 |
1570966877000 |
| CreateTime |
integer |
该查询任务的创建时间。 |
1570966857000 |
| Topic |
string |
该查询任务的 Topic。 |
test |
| UserId |
string |
查询用户 ID。 |
27296756265288**** |
| InstanceId |
string |
实例 ID。 |
MQ_INST_111111111111_DOxxxxxx |
| MsgId |
string |
该查询任务对应的 Message ID。 |
1E05791C117818B4AAC23B1BB0CE**** |
| TraceList |
object |
||
| TraceMapDo |
array<object> |
该查询任务的匹配轨迹列表。 |
|
|
array<object> |
|||
| Status |
string |
发送状态。取值说明如下:
|
SEND_SUCCESS |
| MsgKey |
string |
消息的 Key ,即 Message Key。 |
ORDERID_100 |
| PubTime |
integer |
消息发送时间。 |
1570850870478 |
| SubList |
object |
||
| SubMapDo |
array<object> |
消息的消费轨迹列表。 |
|
|
array<object> |
|||
| ClientList |
object |
||
| SubClientInfoDo |
array<object> |
该 Group ID 客户端消费记录的明细列表。 |
|
|
object |
|||
| Status |
string |
消费状态。取值说明如下:
|
CONSUME_SUCCESS |
| SubTime |
integer |
消费开始时间戳。 |
1570851590511 |
| ReconsumeTimes |
integer |
本次消费的投递轮次。 |
1 |
| SubGroupName |
string |
该客户端所属的 Group ID。 |
GID_test |
| ClientHost |
string |
消费客户端的客户端地址。 |
30.5.**.** |
| CostTime |
integer |
本次消费耗时,单位毫秒。 |
43 |
| FailCount |
integer |
该 Group ID 消费失败次数统计。 |
0 |
| SubGroupName |
string |
消费方 Group ID。 |
GID_test |
| SuccessCount |
integer |
该 Group ID 消费成功次数统计。 |
1 |
| Topic |
string |
消息的 Topic。 |
test |
| CostTime |
integer |
发送耗时,单位毫秒。 |
24 |
| Tag |
string |
消息的 Tag,即 Message Tag。 |
TagA |
| MsgId |
string |
消息的 ID,即 Message ID。 |
0BC1F01800002A9F000000531246**** |
| PubGroupName |
string |
发送方客户端配置的 Group ID。 |
GID_test |
| BornHost |
string |
消息发送方的客户端地址。 |
30.5.**.** |
| QueryId |
string |
查询任务 ID。 |
272967562652883649157096685**** |
示例
正常返回示例
JSON格式
{
"RequestId": "84EE24D2-851F-40D6-B99E-4D6AB909****",
"TraceData": {
"Status": "finish",
"MsgKey": "ORDERID_100",
"UpdateTime": 1570966877000,
"CreateTime": 1570966857000,
"Topic": "test",
"UserId": "27296756265288****",
"InstanceId": "MQ_INST_111111111111_DOxxxxxx",
"MsgId": "1E05791C117818B4AAC23B1BB0CE****",
"TraceList": {
"TraceMapDo": [
{
"Status": "SEND_SUCCESS",
"MsgKey": "ORDERID_100",
"PubTime": 1570850870478,
"SubList": {
"SubMapDo": [
{
"ClientList": {
"SubClientInfoDo": [
{
"Status": "CONSUME_SUCCESS",
"SubTime": 1570851590511,
"ReconsumeTimes": 1,
"SubGroupName": "GID_test",
"ClientHost": "30.5.**.**",
"CostTime": 43
}
]
},
"FailCount": 0,
"SubGroupName": "GID_test",
"SuccessCount": 1
}
]
},
"Topic": "test",
"CostTime": 24,
"Tag": "TagA",
"MsgId": "0BC1F01800002A9F000000531246****",
"PubGroupName": "GID_test",
"BornHost": "30.5.**.**"
}
]
},
"QueryId": "272967562652883649157096685****"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。