查询消息轨迹
功能介绍
查询消息轨迹。
URI
GET /v2/{engine}/{project_id}/instances/{instance_id}/trace
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
engine |
是 |
String |
消息引擎。 缺省值：reliability |
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
msg_id |
是 |
String |
消息ID。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
trace |
Array of trace objects |
消息轨迹列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
success |
Boolean |
是否成功。 |
|
trace_type |
String |
轨迹类型 |
|
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 |
消息类型。 |
|
transaction_state |
String |
事务状态。 |
|
transaction_id |
String |
事务ID。 |
|
from_transaction_check |
Boolean |
是否为事务回查的响应。 |
请求示例
查询RocketMQ实例的消息轨迹。
GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/trace?msg_id={msg_id}
响应示例
状态码： 200
查询成功。
[ {
"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" : null,
"transaction_id" : null,
"from_transaction_check" : false
} ]
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功。 |
错误码
请参见错误码。
