Querying the Message Trace

Function

This API is used to query the message trace.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine. Default: reliability
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
msg_id	Yes	String	Message ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
trace	Array of trace objects	Message trace list.

**Table 4** trace
Parameter	Type	Description
success	Boolean	Whether the request is successful.
trace_type	String	Trace type.
timestamp	Number	Time.
group_name	String	Producer group or consumer group.
cost_time	Number	Time spent.
request_id	String	Request ID.
consume_status	Number	Consumption status. 0: successful; 1: timeout; 2: abnormal; 3: null; 5: failed
topic	String	Topic name.
msg_id	String	Message ID.
offset_msg_id	String	Offset message ID.
tags	String	Message tag.
keys	String	Message keys.
store_host	String	IP address of the host that stores the message.
client_host	String	IP address of the host that generates the message.
retry_times	Integer	Number of retry times.
body_length	Number	Message body length.
msg_type	String	Message type.
transaction_state	String	Transaction status.
transaction_id	String	Transaction ID.
from_transaction_check	Boolean	Whether the response is a transaction check response.

Example Requests

Querying the message trace of a RocketMQ instance

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

Example Responses

Status code: 200

The query is successful.

[ {
  "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
} ]