通过传入轨迹查询任务的ID获取之前的轨迹查询结果。
接口说明
注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
- 若您已根据 Message ID 或者 Message Key 创建了轨迹查询任务,并得到了查询任务的 ID。您可调用本接口根据查询任务 ID 获取对应的轨迹结果的明细。轨迹查询任务通过 OnsTraceQueryByMsgId 或 OnsTraceQueryByMsgKey 接口创建,返回数据中的 QueryId 即为本接口中需要传入的查询任务 ID。
- 因为消息轨迹查询任务耗时较多,创建任务后立即根据该接口获取结果可能为空,若遇到此情况,建议等待一段时间再重试。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mq:GetTraceResult |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
QueryId | string | 是 | 需要提取轨迹查询结果的任务 ID。 | 272967562652883649157096685**** |
InstanceId | string | 否 | 需查询的消息所对应的实例 ID。 | MQ_INST_111111111111_DOxxxxxx |
Topic | string | 否 | 需查询的消息的 Topic。 | test |
返回参数
示例
正常返回示例
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****"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-19 | OpenAPI 入参发生变更 | 查看变更详情 |
控制台操作
除了调用 OnsTraceGetResult 接口,您还可以通过云消息队列 RocketMQ 版控制台查看消息轨迹的查询结果。具体操作,请参见查询消息轨迹。