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 示例值：rocketmq-4k4orqgq |
| EnvironmentId | 是 | String | 命名空间 示例值：test_namespace |
| TopicName | 是 | String | 主题，rocketmq查询死信时值为groupId 示例值：test_topic |
| MsgId | 是 | String | 消息id 示例值：092BAE5A1656070DEA4E276DF0760089 |
| GroupName | 否 | String | 消费组、订阅 示例值：test_group |
| QueryDeadLetterMessage | 否 | String | 查询死信时该值为true 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Array of TraceResult | 轨迹详情列表 示例值：[ { "Stage": "produce", "Data": { "Status": 1 } }, { "Stage": "persist", "Data": { "Status": 1 } } ] |
| ShowTopicName | String | 消息轨迹页展示的topic名称 示例值：test_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": "rocketmq-4k4orqgq",
"EnvironmentId": "test_namespace",
"TopicName": "test_topic",
"MsgId": "01963F0B14BAF0B5360728F44800000000",
"GroupName": "test_group",
"QueryDLQMsg": true
}输出示例
{
"Response": {
"Result": [
{
"Stage": "produce",
"Data": "{\"MsgId\":\"01963F0B14BAF0B5360728F44800000000\",\"Status\":0,\"ProduceTime\":\"2024-10-22 15:54:49,124\",\"ProducerAddr\":\"111.206.94.148:47557\",\"MsgKey\":\"yourMessageKey-1c151062f96e\",\"MsgTags\":\"yourMessageTagA\",\"Duration\":10}"
},
{
"Stage": "persist",
"Data": "{\"MsgId\":\"01963F0B14BAF0B5360728F44800000000\",\"Status\":0,\"PersistTime\":\"2024-10-22 15:54:49,132\"}"
},
{
"Stage": "consume",
"Data": "{\"TotalCount\":1,\"RocketMqConsumeLogs\":[{\"MsgId\":\"01963F0B14BAF0B5360728F44800000000\",\"Status\":2,\"PushTime\":\"2024-10-22 15:55:00,122\",\"ConsumerAddr\":\"111.206.94.148:53792\",\"ConsumerGroup\":\"test_group\",\"RetryTimes\":1}]}"
}
],
"ShowTopicName": "news-topic",
"RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| ResourceNotFound.Cluster | 集群不存在。 |
