热门活动
全部活动
1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
rocketmq消息详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRocketMQMsg。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群id 示例值：rocketmq-4k4orqgq |
| EnvironmentId | 是 | String | 命名空间 示例值：test_namespace |
| TopicName | 是 | String | 主题，查询死信时传groupId 示例值：test_topic |
| MsgId | 是 | String | 消息id 示例值：092BAE5A1656070DEA4E276DF0760089 |
| PulsarMsgId | 是 | String | pulsar消息id 示例值：092BAE5A1656070DEA4E276DF0760089 |
| QueryDeadLetterMessage | 否 | Boolean | 查询死信时该值为true，只对Rocketmq有效 示例值：false |
| Offset | 否 | Integer | 分页Offset 示例值：0 |
| Limit | 否 | Integer | 分页Limit 示例值：20 |
| FilterTrackGroup | 否 | String | 根据消费组名称过滤消费详情 示例值：test_group |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Body | String | 消息体 示例值：order-id-2ksn3b23 |
| Properties | String | 详情参数 示例值：{"type":"normal"} |
| ProduceTime | String | 生产时间 示例值： 2021-11-23 21:21:26 |
| MsgId | String | 消息id 示例值：092BAE5A1656070DEA4E276DF0760089 |
| ProducerAddr | String | 生产者地址 示例值：9.43.174.90 |
| MessageTracks | Array of RocketMQMessageTrack | 消费组消费情况列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Group":"test_group", "ConsumeStatus":"CONSUMED", "TrackType":"CONSUMED", "ExceptionDesc":""}] |
| ShowTopicName | String | 详情页展示的topic名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_topic |
| MessageTracksCount | Integer | 消费组消费情况列表总数 示例值：100 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询消息详情
输入示例
输出示例
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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| ResourceNotFound.Cluster | 集群不存在。 |
