1. 接口描述
接口请求域名： trocket.tencentcloudapi.com 。
根据消息 ID 查询消息轨迹。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMessageTrace。 |
| Version | 是 | String | 公共参数，本接口取值：2023-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 腾讯云 RocketMQ 实例 ID，从 DescribeInstanceList 接口或控制台获得。 示例值：rmq-72mo3a9o |
| Topic | 是 | String | 主题名称，从 DescribeTopicList 接口或控制台获得。 示例值：test_topic |
| MsgId | 是 | String | 消息 ID，从 DescribeMessageList 接口或业务日志中获得。 示例值：1EAE3915000721B8D17C2C5BB31638D1 |
| QueryDeadLetterMessage | 否 | Boolean | 是否是死信消息，默认为false 示例值：false |
| QueryDelayMessage | 否 | Boolean | 是否是延时消息，默认为false 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ShowTopicName | String | 主题名称 示例值：test_topic |
| Data | Array of MessageTraceItem | 轨迹详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询普通消息的轨迹
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMessageTrace
<公共请求参数>
{
"InstanceId": "rmq-72mo3a9o",
"Topic": "topic",
"MsgId": "1EAE3915000721B8D17C2C5BB31638D1"
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"Data": "{\"MsgId\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"Status\":0,\"ProduceTime\":\"2023-05-09 14:43:27,127\",\"ProducerAddr\":\"30.174.57.21\",\"MsgKey\":\"testKey\",\"MsgTags\":\"testTag\",\"Duration\":76}",
"Stage": "produce"
},
{
"Data": "{\"MsgId\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"Status\":0,\"PersistTime\":\"2023-05-09 14:43:27,184\"}",
"Stage": "persist"
},
{
"Data": "{\"TotalCount\":1,\"RocketMqConsumeLogs\":[{\"MsgId\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"Status\":2,\"PushTime\":\"2023-05-09 14:43:27,205\",\"ConsumerAddr\":\"11.139.244.247\",\"ConsumerGroup\":\"group\",\"RetryTimes\":1}]}",
"Stage": "consume"
}
],
"RequestId": "0112153a-8cba-44f1-b7a5-5e412d493940",
"ShowTopicName": "test_topic"
}
}示例2 查询延迟消息的轨迹
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMessageTrace
<公共请求参数>
{
"InstanceId": "rmq-cdqzmmgz8o",
"Topic": "",
"MsgId": "010242ECB90067325E06F41EFF00000000",
"QueryDelayMessage": true
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"Data": "{\"MsgId\":\"010242ECB90067325E06F41EFF00000000\",\"Status\":0,\"ProduceTime\":\"2024-09-12 14:06:55,591\",\"ProducerAddr\":\"9.218.232.160:32038\",\"MsgKey\":\"topic1\",\"MsgTags\":\"tag0\",\"Duration\":2}",
"Stage": "produce"
},
{
"Data": "{\"MsgId\":\"010242ECB90067325E06F41EFF00000000\",\"Status\":0,\"PersistTime\":\"2024-09-12 14:06:55,590\"}",
"Stage": "persist"
},
{
"Data": "{\"TotalCount\":0,\"RocketMqConsumeLogs\":[]}",
"Stage": "consume"
}
],
"RequestId": "2e4374f9-0c98-4d77-af20-2bc414ccaefd",
"ShowTopicName": "test_topic"
}
}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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.Instance | 实例不存在。 |
| ResourceNotFound.Message | 消息不存在。 |
