更新时间:2024-07-05 GMT+08:00

查询消息轨迹

功能介绍

查询消息轨迹。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

消息引擎。

project_id

String

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

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

msg_id

String

消息ID。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

trace

Array of trace objects

消息轨迹列表。

表4 trace

参数

参数类型

描述

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

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码