1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
消息查询
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTopicMsgs。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvironmentId | 是 | String | 环境（命名空间）名称。 示例值：default |
| TopicName | 是 | String | 主题名。 示例值：test-topic3 |
| StartTime | 是 | String | 开始时间。 示例值：2020-09-22 00:00:00 |
| EndTime | 是 | String | 结束时间。 示例值：2020-09-22 00:00:00 |
| Offset | 否 | Integer | 起始下标，不填默认为0。 示例值：2 |
| Limit | 否 | Integer | 返回数量，不填则默认为10，最大值为20。 示例值：2 |
| MsgId | 否 | String | 消息ID。 示例值：test |
| ClusterId | 否 | String | Pulsar 集群的ID 示例值：test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总记录数。 示例值：10000 |
| TopicMsgLogSets | Array of MsgLog | 消息日志列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 消息查询
输入示例
https://tdmq.tencentcloudapi.com/?Action=DescribeTopicMsgs
&EnvironmentId=default
&TopicName=test-topic3
&StartTime=2020-09-22 00:00:00
&EndTime=2020-09-22 00:00:00
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 10000,
"TopicMsgLogSets": [
{
"MsgId": "15591:9:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:14,281",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:8:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:14,074",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:7:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:13,867",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:6:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:13,658",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:5:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:13,449",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:4:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:13,242",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:3:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:13,015",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:2:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:12,808",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:1:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:12,600",
"ProducerAddr": "9.139.220.17:37960"
},
{
"MsgId": "15591:0:-1",
"ProducerName": "fisrtProducer",
"ProduceTime": "2020-08-14 16:47:12,390",
"ProducerAddr": "9.139.220.17:37960"
}
],
"RequestId": "msgs"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidParams | 参数值不在允许范围内。 |
| MissingParameter.NeedMoreParams | 必要参数没有传递。 |
| ResourceNotFound.BrokerCluster | 服务的集群不存在。 |
| ResourceNotFound.Cluster | 集群不存在。 |
| ResourceNotFound.Environment | 环境不存在。 |
| ResourceNotFound.Topic | 主题不存在。 |
