1. 接口描述
接口请求域名: mqtt.tencentcloudapi.com 。
根据订阅查询消息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeMessageByTopic。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 腾讯云MQTT实例ID,从 DescribeInstanceList接口或控制台获得。 示例值:mqtt-xxxx |
| Topic | 是 | String | home/room 示例值:发送topic或者订阅表达式 |
| StartTime | 是 | Integer | 开始时间,毫秒级时间戳 。 示例值:1712025623202 |
| MaxNumber | 否 | Integer | 查询消息条数,最大1024,默认100. 示例值:100 |
| FilterExpression | 否 | String | 消息 body 过滤表达式(Base64 编码),jq 1.6 语法 枚举值:
示例值:LmxldmVsID09ICJFUlJPUiI= |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of MQTTMessage | 消息列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMessageByTopic
<公共请求参数>
{
"InstanceId": "mqtt-mwe5jvvr",
"Topic": "home/room/1",
"StartTime": 1776739183514,
"MaxNumber": 1024,
"FilterExpression": "LmxldmVsID09ICJFUlJPUiI="
}
输出示例
{
"Response": {
"Data": [
{
"ClientId": "client-1",
"MessageId": "155A50E000486587524C6954F59CD00C",
"OriginTopic": "home/room/1",
"Qos": "1",
"StoreTimestamp": 1776739975581
}
],
"RequestId": "795c52c7-ff55-4cb4-8371-387789a41265"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InstanceNotReady | FailedOperation.InstanceNotReady |
| ResourceNotFound.Instance | ResourceNotFound.Instance |