1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
rocketmq 消息查询
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRocketMQTopicMsgs。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群 ID 示例值:rocketmq-xxx |
EnvironmentId | 是 | String | 命名空间 示例值:ns |
TopicName | 是 | String | 主题名称,查询死信时为groupId 示例值:topic |
StartTime | 是 | String | 开始时间 示例值:2021-12-22 12:22:22 |
EndTime | 是 | String | 结束时间 示例值:2021-12-22 12:22:22 |
MsgId | 否 | String | 消息 ID 示例值:msgid |
MsgKey | 否 | String | 消息 key 示例值:msgkey |
Offset | 否 | Integer | 查询偏移 示例值:1 |
Limit | 否 | Integer | 查询限额 示例值:20 |
TaskRequestId | 否 | String | 标志一次分页事务 示例值:2e5ecbb3-f2d6-49d3-9c82-8648f8ed8748 |
NumOfLatestMsg | 否 | Integer | 查询最近N条消息 最大不超过1024,默认-1为其他查询条件 示例值:100 |
Tag | 否 | String | TAG表达式 |
QueryDeadLetterMessage | 否 | Boolean | 死信查询时该值为true,只对Rocketmq有效 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数 示例值:20 |
TopicMsgLogSets | Array of RocketMQMsgLog | 消息列表 |
TaskRequestId | String | 标志一次分页事务 注意:此字段可能返回 null,表示取不到有效值。 示例值:2e5ecbb3-f2d6-49d3-9c82-8648f8ed8748 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取消息列表
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQTopicMsgs
<公共请求参数>
{
"ClusterId": "rocketmq-zpz97455xwap",
"EnvironmentId": "namespace",
"TopicName": "test_topic",
"MsgId": "",
"MsgKey": "",
"StartTime": "2023-10-08 15:44:59",
"EndTime": "2023-10-08 16:14:59",
"Offset": 0,
"Limit": 20,
"TaskRequestId": "abc",
"QueryDlqMsg": true,
"NumOfLatestMsg": 0,
"Tag": "",
"QueryDeadLetterMessage": true
}
输出示例
{
"Response": {
"RequestId": "e3bba45e-876a-4107-ad5d-88006c1ddba2",
"TotalCount": 25,
"TopicMsgLogSets": [
{
"MsgId": "092BAE5A1656070DEA4E276DF0760089",
"MsgTag": "msgTag",
"MsgKey": "msgKey",
"ProducerAddr": "9.43.174.90",
"ProduceTime": "2023-10-08 15:45:16",
"PulsarMsgId": "092BAE5A1656070DEA4E276DF0760089",
"DeadLetterResendTimes": null,
"ResendSuccessCount": null
}
],
"TaskRequestId": "df71cc0a-3057-416b-b878-f0fe015e9913"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
ResourceNotFound.BrokerCluster | 服务的集群不存在。 |
ResourceNotFound.Cluster | 集群不存在。 |