文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>消息队列 MQTT 版>集群相关接口>查询MQTT详细信息

查询MQTT详细信息

最近更新时间：2025-09-12 03:04:39

我的收藏

本页目录：

1. 接口描述

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

查询MQTT消息详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeMessageDetails。
Version 是 String 公共参数，本接口取值：2024-05-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。
示例值：mqtt-xxxx
MessageId 是 String 消息ID
示例值：0B8D67D3003505C29BFD077EC65B0002
Subscription 否 String 订阅表达式
示例值：home/room

3. 输出参数

参数名称 类型 描述
Body String 消息体
示例值：body
UserProperties Array of UserProperty 用户自定义属性
StoreTimestamp Integer 消息存储时间，毫秒级时间戳。
示例值：1745828681259
MessageId String 消息ID
示例值：0B8D67D3003505C29BFD077EC65B0002
ClientId String 生产者地址
示例值：client-1
Qos String Topic
示例值：1
OriginTopic String 源topic
示例值：home/room
ContentType String 内容类型（MQTT5）
含义：指示消息载荷的内容类型，使用标准的 MIME 类型格式。这帮助接收方正确解析和处理消息内容。
示例：
application/json：表示载荷是 JSON 格式的数据。
text/plain：表示载荷是纯文本。
application/octet-stream：表示载荷是二进制数据。
示例值：application/json
PayloadFormatIndicator Integer 载荷格式指示符（MQTT5）
含义：指示载荷的格式，是一个布尔值。0表示未指定格式（二进制），1表示 UTF-8 编码的字符串。
示例：
值为0：当载荷是二进制数据，如图片、音频等。
值为1：当载荷是 UTF-8 编码的文本，如 JSON 字符串、XML 等。
示例值：0
MessageExpiryInterval Integer 消息过期间隔（MQTT5）
含义：指定消息在被丢弃前的有效时间（秒）。如果消息在过期前未能送达，则会被 MQTT 服务器丢弃。
示例：
值为60：表示消息在发布后的 60 秒内有效，过期后未送达则被丢弃。
值为0：表示消息不过期，永久有效（直到被接收或会话结束）。
示例值：60
ResponseTopic String 响应主题（MQTT5）
含义：指定一个主题，用于请求 - 响应模式中的响应消息。发送方可以指定接收方应该将响应发送到哪个主题。
示例：
发送方发布请求到主题devices/device1/commands，并设置ResponseTopic为devices/device1/responses。
接收方处理请求后，将响应发布到devices/device1/responses主题。
示例值：home/room1
CorrelationData String 关联数据（MQTT5）
含义：用于关联请求和响应的标识符，通常是一个字节数组。在请求 - 响应模式中，发送方设置此值，接收方在响应中包含相同的值，以便发送方识别响应对应的请求。
示例：
发送方生成一个唯一 ID（如 UUID 的字节数组）作为CorrelationData，附加到请求消息中。
接收方在响应消息中包含相同的CorrelationData，发送方通过比较此值来匹配响应和请求。
示例值：uuid
SubscriptionIdentifier String 订阅标识符（MQTT5）
含义：为订阅分配的唯一标识符，用于标识客户端的特定订阅。当服务器向客户端发送消息时，可以包含此标识符，帮助客户端识别消息对应的订阅。
示例：
客户端订阅主题devices/+/temperature，并设置SubscriptionIdentifier为123。
当服务器向客户端发送此主题的消息时，会在消息中包含SubscriptionIdentifier: 123，客户端可以根据此值知道消息是通过哪个订阅接收的。
示例值：subs-1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

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

{
    "InstanceId": "mqtt-g839agr2",
    "MessageId": "15397032005D639FEE4893603732005C"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Body": "this is body",
        "ClientId": "client1",
        "MessageId": "15397032005D639FEE4893603732005C",
        "OriginTopic": "home/room3",
        "Qos": "1",
        "RequestId": "ba5d5d6a-64c9-40cf-8889-21efed76389d",
        "StoreTimestamp": "1745828681259",
        "UserProperties": [
            {
                "Key": "key1",
                "Value": "value-1"
            },
            {
                "Key": "key2",
                "Value": "value-2"
            }
        ]
    }
}

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.Instance
ResourceNotFound.Message ResourceNotFound.Message
中国站
目录