Updated on 2026-01-23 GMT+08:00

Querying the Message Trace

Function

This API is used to query the message trace.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Message engine.

Constraints

N/A

Range

N/A

Default Value

reliability

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

msg_id

Yes

String

Definition

Message ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Number

Definition

Total number.

Constraints

N/A

Range

N/A

Default Value

N/A

next_offset

Integer

Definition

Offset of the next page.

Constraints

N/A

Range

N/A

Default Value

N/A

previous_offset

Integer

Definition

Offset of the previous page.

Constraints

N/A

Range

N/A

Default Value

N/A

trace

Array of trace objects

Definition

Message trace list.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 trace

Parameter

Type

Description

success

Boolean

Definition

Successful or not.

Constraints

N/A

Range

  • true: successful

  • false: failed

Default Value

N/A

trace_type

String

Definition

Trace type.

Constraints

N/A

Range

  • Pub: The producer successfully sends messages.

  • SubBefore: The consumer is ready to consume messages.

  • SubAfter: The consumer finishes consuming messages.

  • EndTransaction: Transactional messages are committed or rolled back.

  • Receive: The service side receives messages.

  • Ack: The consumer manually acknowledges consumption.

Default Value

N/A

timestamp

Number

Definition

Time.

Constraints

N/A

Range

N/A

Default Value

N/A

group_name

String

Definition

Producer group or consumer group.

Constraints

N/A

Range

N/A

Default Value

N/A

cost_time

Number

Definition

Duration.

Constraints

N/A

Range

N/A

Default Value

N/A

request_id

String

Definition

Request ID.

Constraints

N/A

Range

N/A

Default Value

N/A

consume_status

Number

Definition

Consumption status.

Constraints

N/A

Range

  • 0: Successful

  • 1: Timeout

  • 2: Exception

  • 3: Null

  • 5: Failed

Default Value

N/A

topic

String

Definition

Topic name.

Constraints

N/A

Range

N/A

Default Value

msg_id

String

Definition

Message ID.

Constraints

N/A

Range

N/A

Default Value

N/A

offset_msg_id

String

Definition

Offset message ID.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

String

Definition

Message tag.

Constraints

N/A

Range

N/A

Default Value

N/A

keys

String

Definition

Message keys.

Constraints

N/A

Range

N/A

Default Value

N/A

store_host

String

Definition

IP address of the host that stores the message.

Constraints

N/A

Range

N/A

Default Value

N/A

client_host

String

Definition

IP address of the host that generates the message.

Constraints

N/A

Range

N/A

Default Value

N/A

retry_times

Integer

Definition

Number of retry times.

Constraints

N/A

Range

N/A

Default Value

N/A

body_length

Number

Definition

Message body length.

Constraints

N/A

Range

N/A

Default Value

N/A

msg_type

String

Definition

Message type.

Constraints

N/A

Range

  • Normal_Msg: normal message

  • Trans_Msg_Half: half message

  • Trans_msg_Commit: delivered message

  • Delay_Msg: delayed message

  • Order_Msg: ordered message

Default Value

N/A

transaction_state

String

Definition

Transaction status.

Constraints

N/A

Range

  • COMMIT_MESSAGE

  • ROLLBACK_MESSAGE

  • UNKNOW

Default Value

N/A

transaction_id

String

Definition

Transaction ID.

Constraints

N/A

Range

N/A

Default Value

N/A

from_transaction_check

Boolean

Definition

Whether the response is a transaction check response.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

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.

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

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;


public class ListMessageTraceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ListMessageTraceRequest request = new ListMessageTraceRequest();
        request.withEngine(ListMessageTraceRequest.EngineEnum.fromValue("{engine}"));
        request.withInstanceId("{instance_id}");
        try {
            ListMessageTraceResponse response = client.listMessageTrace(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListMessageTraceRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        response = client.list_message_trace(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListMessageTraceRequest{}
	request.Engine = model.GetListMessageTraceRequestEngineEnum().ENGINE
	request.InstanceId = "{instance_id}"
	response, err := client.ListMessageTrace(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The query is successful.

Error Codes

See Error Codes.