API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心

查询RocketMQ消息轨迹

最近更新时间：2024-03-12 01:53:47

我的收藏

本页目录：

1. 接口描述

接口请求域名： tdmq.tencentcloudapi.com 。

查询消息轨迹

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRocketMQMsgTrace。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterId 是 String 集群id
示例值：pulsar-xxx
EnvironmentId 是 String 命名空间
示例值：xxx
TopicName 是 String 主题，rocketmq查询死信时值为groupId
示例值：xxx
MsgId 是 String 消息id
示例值：xxx
GroupName 否 String 消费组、订阅
示例值：xxx
QueryDeadLetterMessage 否 String 查询死信时该值为true
示例值：false

3. 输出参数

参数名称 类型 描述
Result Array of TraceResult [
{
"Stage": "produce",
"Data": {
"ProducerName": "生产者名",
"ProduceTime": "消息生产时间",
"ProducerAddr": "客户端地址",
"Duration": "耗时ms",
"Status": "状态（0：成功，1：失败）"
}
},
{
"Stage": "persist",
"Data": {
"PersistTime": "存储时间",
"Duration": "耗时ms",
"Status": "状态（0：成功，1：失败）"
}
},
{
"Stage": "consume",
"Data": {
"TotalCount": 2,
"RocketMqConsumeLogs": [
{
"ConsumerGroup": "消费组",
"ConsumeModel": "消费模式",
"ConsumerAddr": "消费者地址",
"ConsumeTime": "推送时间",
"Status": "状态（0:已推送未确认, 2:已确认, 3:转入重试, 4:已重试未确认, 5:已转入死信队列）"
},
{
"ConsumerGroup": "消费组",
"ConsumeModel": "消费模式",
"ConsumerAddr": "消费者地址",
"ConsumeTime": "推送时间",
"Status": "状态（0:已推送未确认, 2:已确认, 3:转入重试, 4:已重试未确认, 5:已转入死信队列）"
}
]
}
}
]
示例值：xxx
ShowTopicName String 消息轨迹页展示的topic名称
示例值：topic
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询消息轨迹

查询消息轨迹

输入示例

POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQMsgTrace
<公共请求参数>

{
    "ClusterId": "abc",
    "EnvironmentId": "abc",
    "TopicName": "abc",
    "MsgId": "abc",
    "GroupName": "abc",
    "QueryDLQMsg": true
}

输出示例

{
    "Response": {
        "Result": [
            {
                "Stage": "abc",
                "Data": "abc"
            }
        ],
        "ShowTopicName": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
ResourceNotFound.Cluster 集群不存在。
中国站