1. 接口描述
接口请求域名： trocket.tencentcloudapi.com 。
查询消息列表，如查询死信，请设置ConsumerGroup参数
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMQTTMessageList。 |
| Version | 是 | String | 公共参数，本接口取值：2023-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：rocketmq-xxxx |
| Topic | 是 | String | 主题 示例值：test |
| StartTime | 是 | Integer | 开始时间 示例值：1712025623202 |
| EndTime | 是 | Integer | 结束时间 示例值：1712112023202 |
| TaskRequestId | 是 | String | 请求任务id 示例值：dcfefe36-829d-4dd8-a436-e622c6ecab8f |
| Offset | 否 | Integer | 查询起始位置 示例值：0 |
| Limit | 否 | Integer | 查询结果限制数量 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 查询总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| Data | Array of MQTTMessageItem | 消息记录列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "MsgId": "0B8D67D3003505C29BFD077EC81A0005", "SubTopic": "/humidity/room1/", "Qos": "2", "Tags": "MQTT_COMMON", "Keys": null, "ProducerAddr": "11.176.16.153:26866", "ProduceTime": "2024-04-02 10:55:49", "DeadLetterResendTimes": null, "DeadLetterResendSuccessTimes": null }, { "MsgId": "0B8D67D3003505C29BFD077EC65B0002", "SubTopic": "/humidity/room0/", "Qos": "2", "Tags": "MQTT_COMMON", "Keys": null, "ProducerAddr": "11.176.16.153:26866", "ProduceTime": "2024-04-02 10:55:48", "DeadLetterResendTimes": null, "DeadLetterResendSuccessTimes": null } ] |
| TaskRequestId | String | 请求任务id 示例值：dcfefe36-829d-4dd8-a436-e622c6ecab8f |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTMessageList
<公共请求参数>
{
"InstanceId": "mqtt-47ka4rdr",
"Topic": "topic24",
"Offset": 0,
"Limit": 20,
"StartTime": 1705373755266,
"EndTime": 1705632955266,
"TaskRequestId": " "
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"DeadLetterResendSuccessTimes": null,
"DeadLetterResendTimes": null,
"Keys": null,
"MsgId": "0B8D67F0002D6ACBCFC0557BCEBA0001",
"ProduceTime": "2024-01-17 14:22:57",
"ProducerAddr": "11.176.16.153:51134",
"Qos": "1",
"SubTopic": "/1/",
"Tags": "MQTT_COMMON"
},
{
"DeadLetterResendSuccessTimes": null,
"DeadLetterResendTimes": null,
"Keys": null,
"MsgId": "0B8D67F0002D6ACBCFC0557B1A980000",
"ProduceTime": "2024-01-17 14:22:11",
"ProducerAddr": "11.176.16.153:44044",
"Qos": "0",
"SubTopic": "",
"Tags": "MQTT_COMMON"
}
],
"RequestId": "116cd3f5-668f-42fe-8572-fcd5d3a31377",
"TaskRequestId": "e3d14393-4701-4f62-8a7d-b52bd59b5ace",
"TotalCount": 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 | 实例不存在。 |