管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>消息队列 RocketMQ 版>消息相关接口>查询消息详情

查询消息详情

最近更新时间：2025-06-25 17:43:27

我的收藏

本页目录：

1. 接口描述

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

查询消息详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeMessage。
Version 是 String 公共参数，本接口取值：2023-03-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 腾讯云 RocketMQ 实例 ID，从 DescribeInstanceList 接口或控制台获得。
示例值：rmq-72mo3a9o
Topic 是 String 主题名称，从 DescribeTopicList 接口或控制台获得。
示例值：test_topic
MsgId 是 String 消息 ID，从 DescribeMessageList 接口或业务日志中获得。
示例值：01963F0B14BAF09F27077D244F00000000
Offset 否 Integer 查询起始位置，默认为0。
示例值：0
Limit 否 Integer 查询结果限制数量，默认20。
示例值：20
QueryDeadLetterMessage 否 Boolean 是否是死信消息，默认为false
示例值：false
QueryDelayMessage 否 Boolean 是否是延时消息，默认为false
示例值：false

3. 输出参数

参数名称 类型 描述
Body String 消息体
示例值：This is a normal message for Apache RocketMQ
Properties String 详情参数
示例值：{ "UNIQ_KEY": "01963F0B14BAF09F27077D244F00000000", "__CLIENT_HOST": "113.142.183.133:46728" }
ProduceTime String 生产时间
示例值：2023-01-01 00:00:01
MessageId String 消息ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：01963F0B14BAF09F27077D244F00000000
ProducerAddr String 生产者地址
示例值：113.142.183.133:46728
MessageTracks Array of MessageTrackItem 消息消费情况列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[ { "ConsumerGroup": "test_group", "TrackType": "NOT_ONLINE", } ]
ShowTopicName String 主题名称
示例值：test_topic
MessageTracksCount Integer 消息消费情况列表总条数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询普通消息

输入示例

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

{
    "InstanceId": "rmq-72mo3a9o",
    "Topic": "topic",
    "MsgId": "1EAE3915000721B8D17C2C5BB31638D1"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Body": "testBody",
        "MessageId": "1EAE3915000721B8D17C2C5BB31638D1",
        "MessageTracksCount": 1,
        "MessageTracks": [
            {
                "ConsumeStatus": "CONSUMED",
                "ConsumerGroup": "group",
                "ExceptionDesc": null,
                "TrackType": "CONSUMED"
            }
        ],
        "ProduceTime": "2023-05-09 14:43:27",
        "ProducerAddr": "30.174.57.21",
        "Properties": "{\"TRACE_ON\":\"true\",\"MSG_REGION\":\"cd\",\"KEYS\":\"testKey\",\"UNIQ_KEY\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"CLUSTER\":\"rmqbroker-cd-1\",\"WAIT\":\"true\",\"TAGS\":\"testTag\"}",
        "RequestId": "8e97b978-376b-4d94-96cc-db0ead5f2f99",
        "ShowTopicName": "topic"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound.Instance 实例不存在。
ResourceNotFound.Message 消息不存在。
中国站
目录