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 |
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。
- 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.Instance |
ResourceNotFound.Message | ResourceNotFound.Message |