AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云消息队列 RocketMQ 版 云消息队列 RocketMQ 4.x系列 开发参考 API参考指南 API目录 轨迹 OnsTraceQueryByMsgId - 根据MsgId创建轨迹查询任务

OnsTraceQueryByMsgId - 根据MsgId创建轨迹查询任务

更新时间：
产品详情
我的收藏

通过传入Topic名称和Message ID创建轨迹查询任务，得到该查询任务的ID。您需要再调用OnsTraceGetResult接口，传入返回的查询任务ID，获取消息轨迹的详细结果。

接口说明

重要 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:QueryTrace

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

 无
  • mq:OnsInstanceBaseInfo

请求参数

名称

类型

必填

描述

示例值
Topic

string

是

需查询的消息的 Topic。

test
MsgId

string

是

需查询的消息的 ID，即 Message ID。

1E05791C117818B4AAC23B1BB0CE****
BeginTime

integer

是

查询的时间范围的起始时间戳，单位：毫秒。

1570852800000
EndTime

integer

是

查询的时间范围的结束时间戳，单位：毫秒。

1570968000000
InstanceId

string

否

需查询的消息的 Topic 所对应的实例 ID。

MQ_INST_111111111111_DOxxxxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

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

B93332A3-160D-404F-880F-1F8736D1****
QueryId

string

该查询任务的 ID，您需要根据该任务 ID 再调用 OnsTraceGetResult 接口获取详细结果。

272967562652883649157096685****

示例

正常返回示例

JSON格式

{
  "RequestId": "B93332A3-160D-404F-880F-1F8736D1****",
  "QueryId": "272967562652883649157096685****"
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：轨迹下一篇：OnsTraceQueryByMsgKey - 根据Message Key创建轨迹查询任务