OnsTraceQueryByMsgKey - 根据Message Key创建轨迹查询任务

通过传入Topic名称和Message Key创建轨迹查询任务,得到该查询任务的ID。

接口说明

注意阿里云提供的OpenAPI属于管控类API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖OpenAPI实现,否则可能会导致链路产生风险。
若您记录了某消息的Message Key,并需要根据此Message Key查询该消息的投递轨迹信息,即可使用本接口创建查询任务。该接口返回任务ID后,再根据OnsTraceGetResult接口传入任务ID即可获取查询结果。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:QueryTraceRead
  • Ons
    acs:mq:*:*:{#TopicName}
  • Ons
    acs:mq:*:*:{#InstanceId}%{#TopicName}

请求参数

名称类型必填描述示例值
Topicstring

需查询的消息的Topic。

test
MsgKeystring

需查询的消息的Message Key。

ORDERID_100
BeginTimeLong

查询的时间范围的起始时间戳,单位:毫秒。

1570852800000
EndTimeLong

查询的时间范围的结束时间戳,单位:毫秒。

1570968000000
InstanceIdstring

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

MQ_INST_111111111111_DOxxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

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

F8654231-122A-4DBD-801F-38E35538****
QueryIdstring

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

272967562652883649157096685****

示例

正常返回示例

JSON格式

{
  "RequestId": "F8654231-122A-4DBD-801F-38E35538****",
  "QueryId": "272967562652883649157096685****"
}

错误码

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

控制台操作

除了调用OnsTraceQueryByMsgKey接口,您还可以通过消息队列RocketMQ版控制台创建消息轨迹查询任务。具体操作,请参见消息查询

阿里云首页 消息队列RocketMQ版 相关技术圈