更新时间:2026-04-03 GMT+08:00

查询消息轨迹

功能介绍

查询消息轨迹。

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/trace

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

参数解释:

消息引擎。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

reliability。

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

msg_id

是

String

参数解释:

消息ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Number

参数解释:

总数。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

next_offset

Integer

参数解释:

下个分页的offset。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

previous_offset

Integer

参数解释:

上个分页的offset。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

trace

Array of trace objects

参数解释:

消息轨迹列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 trace

参数

参数类型

描述

success

Boolean

参数解释:

是否成功。

约束限制:

不涉及。

取值范围:

  • true:成功。

  • false:失败。

默认取值:

不涉及。

trace_type

String

参数解释:

轨迹类型。

约束限制:

不涉及。

取值范围:

  • Pub:生产者成功发送消息。

  • SubBefore:消费者准备消费消息。

  • SubAfter:消费者完成消息消费。

  • EndTransaction:事务消息被提交或回滚。

  • Receive:服务侧接收消息。

  • Ack:消费者手动确认消费。

默认取值:

不涉及。

timestamp

Number

参数解释:

时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

group_name

String

参数解释:

生产组或消费组。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cost_time

Number

参数解释:

耗时。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

request_id

String

参数解释:

请求ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

consume_status

Number

参数解释:

消费状态:

约束限制:

不涉及。

取值范围:

  • 0-消费成功

  • 1-消费超时

  • 2-消费发生异常

  • 3-消费返回NULL

  • 5-消费失败

默认取值:

不涉及。

topic

String

参数解释:

主题名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

msg_id

String

参数解释:

消息ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

offset_msg_id

String

参数解释:

offset消息ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

tags

String

参数解释:

消息的标签。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

keys

String

参数解释:

消息的keys。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

store_host

String

参数解释:

存储消息的主机IP。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

client_host

String

参数解释:

产生消息的主机IP。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

retry_times

Integer

参数解释:

重试次数。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

body_length

Number

参数解释:

消息体长度。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

msg_type

String

参数解释:

消息类型。

约束限制:

不涉及。

取值范围:

  • Normal_Msg:普通消息。

  • Trans_Msg_Half:事务半消息。

  • Trans_msg_Commit:事务提交消息。

  • Delay_Msg:延迟消息。

  • Order_Msg:顺序消息。

默认取值

不涉及。

transaction_state

String

参数解释:

事务状态。

约束限制:

不涉及。

取值范围:

  • COMMIT_MESSAGE

  • ROLLBACK_MESSAGE

  • UNKNOW

默认取值

不涉及。

transaction_id

String

参数解释:

事务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

from_transaction_check

Boolean

参数解释:

是否为事务回查的响应。

约束限制:

不涉及。

取值范围:

  • true:是事务回查的响应。

  • false:不是事务回查的响应。

默认取值

不涉及。

请求示例

查询RocketMQ实例的消息轨迹。

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/trace?msg_id={msg_id}

响应示例

状态码:200

查询成功。

{
  "total" : 1,
  "next_offset" : -1,
  "previous_offset" : -1,
  "trace" : [ {
    "success" : true,
    "trace_type" : "Pub",
    "timestamp" : 1634822858013,
    "group_name" : "ProducerGroupName",
    "cost_time" : 47,
    "request_id" : "644F0069C829287CBBF26B9A54390000",
    "consume_status" : 0,
    "topic" : "aaaaa",
    "msg_id" : "7F000001561018B4AAC26B9A0D1D0004",
    "offset_msg_id" : "C0A8011700002774000000000000BE12",
    "tags" : "TagA",
    "keys" : "OrderID188",
    "store_host" : "192.168.0.1:10101",
    "client_host" : "127.0.0.1",
    "retry_times" : 0,
    "body_length" : 11,
    "msg_type" : "Normal_Msg",
    "transaction_state" : "Ack",
    "transaction_id" : "xxxxxx",
    "from_transaction_check" : false
  } ]
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。