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

使用说明

  • 业务方已经根据Message ID或者Message Key创建了轨迹查询任务,并得到了查询任务的ID。您可调用本接口根据该任务ID获取对应的轨迹结果的明细。轨迹查询任务通过OnsTraceQueryByMsgIdOnsTraceQueryByMsgKey接口创建,返回数据中的QueryId即为本接口中需要传入的查询任务ID。
  • 因为消息轨迹查询任务耗时较多,创建任务后立即根据该接口获取结果可能为空,若遇到此情况,建议等待一段时间再重试。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例

API

Action

Resource

OnsTraceGetResult

mq:QueryInstanceBaseInfo

acs:mq:*:*:{instanceId}

请求参数

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

系统规定参数。取值:OnsTraceGetResult

QueryId String 272967562652883649157096685****

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

返回数据

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

公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。

TraceData Object

该查询任务的结果明细。

Status String finish

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

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

该查询任务对应的Message Key。

UpdateTime Long 1570966877000

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

CreateTime Long 1570966857000

该查询任务的创建时间。

Topic String test

该查询任务的Topic。

UserId String 27296756265288****

查询用户ID。

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例ID。

MsgId String 1E05791C117818B4AAC23B1BB0CE****

该查询任务对应的Message ID。

TraceList Array of TraceMapDo

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

TraceMapDo
Status String SEND_SUCCESS

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

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

消息的Key ,即Message Key。

PubTime Long 1570850870478

消息发送时间。

SubList Array of SubMapDo

消息的消费轨迹列表。

SubMapDo
ClientList Array of SubClientInfoDo

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

SubClientInfoDo
Status String CONSUME_SUCCESS

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

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

消费开始时间戳。

ReconsumeTimes Integer 1

本次消费的投递轮次。

SubGroupName String GID_test

该客户端所属的Group ID。

ClientHost String 30.5.**.**

消费客户端的客户端地址。

CostTime Integer 43

本次消费耗时,单位毫秒。

FailCount Integer 0

该Group ID消费失败次数统计。

SubGroupName String GID_test

消费方Group ID。

SuccessCount Integer 1

该Group ID消费成功次数统计。

Topic String test

消息的Topic。

CostTime Integer 24

发送耗时,单位毫秒。

Tag String TagA

消息的Tag,即Message Tag。

MsgId String 0BC1F01800002A9F000000531246****

消息的ID,即Message ID。

PubGroupName String GID_test

发送方客户端配置的Group ID。

BornHost String 30.5.**.**

消息发送方的客户端地址。

QueryId String 272967562652883649157096685****

查询任务ID。

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsTraceGetResult
&QueryId=272967562652883649157096685****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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-4D6AB909****</RequestId>
</OnsTraceGetResultResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

控制台操作

除了调用OnsTraceGetResult接口,您还可以通过消息队列RocketMQ版控制台查看消息轨迹的查询结果。具体操作,请参见查询消息轨迹