rocketmq消息详情

最近更新时间: 2026-09-17 00:00:41

1. 接口描述

接口请求域名： tdmq.api3.fincloud.tencent.cn。

rocketmq消息详情

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

接口更新时间：2025-11-18 22:21:43。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeRocketMQMsg
Version	是	否	String	公共参数，本接口取值：2020-02-17
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
EnvironmentId	是	是	String	命名空间示例值： test_ns
MsgId	是	是	String	消息id 示例值： 092BAE5A1656070DEA4E276DF0760089
QueryDlqMsg	否	是	Bool	查询死信时该值为true，只对Rocketmq有效示例值： false
TopicName	是	是	String	主题，查询死信时传groupId 示例值： test_topic
PulsarMsgId	是	是	String	pulsar消息id 示例值： 092BAE5A1656070DEA4E276DF0760089
QueryDeadLetterMessage	否	是	Bool	查询死信时该值为true，只对Rocketmq有效示例值： false
Offset	否	是	Int64	分页Offset 示例值： 0
Limit	否	是	Int64	分页Limit 示例值： 20
FilterTrackGroup	否	是	String	根据消费组名称过滤消费详情示例值： test_group
ClusterId	是	是	String	集群id 示例值： rocketmq-4k4orqgq

3. 输出参数

参数名称	类型	描述
MessageTracksCount	Int64	消费组消费情况列表总数示例值： 100
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	消费组消费情况列表示例值：查看
ShowTopicName	String	详情页展示的topic名称示例值： test_topic
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation
ResourceNotFound.Cluster

5. 示例

示例1 查询消息详情

输入示例

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

{
  "EnvironmentId": "test_ns",
  "ClusterId": "rocketmq-4k4orqgq",
  "TopicName": "test_topic",
  "PulsarMsgId": "092BAE5A1656070DEA4E276DF0760089",
  "MsgId": "092BAE5A1656070DEA4E276DF0760023",
  "QueryDlqMsg": false
}

输出示例

{
  "Response": {
    "Body": "order-id-2ksn3b23",
    "MsgId": "092BAE5A1656070DEA4E276DF0760089",
    "ProduceTime": "2021-11-23 21:21:26",
    "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7",
    "Properties": "",
    "ProducerAddr": "9.43.174.90",
    "ShowTopicName": "test_topic",
    "MessageTracks": [
      {
        "Group": "test_group",
        "ConsumeStatus": "CONSUMED",
        "TrackType": "CONSUMED",
        "ExceptionDesc": ""
      }
    ]
  }
}