消息队列 RocketMQ 版查询消息列表-消息相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： trocket.tencentcloudapi.com 。

查询消息列表。如果查询死信消息，请设置ConsumerGroup参数。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMessageList。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	集群ID 示例值：rmq-72mo3a9o
Topic	是	String	主题名称示例值：test_topic
StartTime	是	Integer	开始时间示例值：1672502400000
EndTime	是	Integer	结束时间示例值：1672504200000
TaskRequestId	是	String	一次查询标识示例值：901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d
Offset	否	Integer	查询起始位置示例值：0
Limit	否	Integer	查询结果限制数量示例值：20
ConsumerGroup	否	String	消费组名称示例值：test_group
MsgId	否	String	消息 ID 示例值：01963F0B14BAF09F27077D244F00000000
MsgKey	否	String	消息 Key 示例值：test_key
RecentMessageNum	否	Integer	查询最近N条消息最大不超过1024，默认-1为其他查询条件示例值：100
QueryDeadLetterMessage	否	Boolean	是否查询死信消息示例值：false
Tag	否	String	消息 Tag 示例值：test_tag

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询总数注意：此字段可能返回 null，表示取不到有效值。示例值：10
Data	Array of MessageItem	消息记录列表注意：此字段可能返回 null，表示取不到有效值。示例值：[ { "MsgId": "01963F0B14BAF09F27077D244F00000000", } ]
TaskRequestId	String	一次查询ID 注意：此字段可能返回 null，表示取不到有效值。示例值：901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询消息列表

输入示例

POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMessageList
<公共请求参数>

{
    "InstanceId": "rmq-72mo3a9o",
    "Topic": "topic",
    "Offset": 0,
    "Limit": 1,
    "MsgId": "1EAE3915000721B8D17C2C5BB31638D1",
    "StartTime": 1683613796174,
    "EndTime": 1683613796174,
    "TaskRequestId": "901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "DeadLetterResendSuccessTimes": null,
                "DeadLetterResendTimes": null,
                "Keys": "test_key",
                "MsgId": "1EAE3915000721B8D17C2C5BB31638D1",
                "ProduceTime": "2023-05-09 14:43:27",
                "ProducerAddr": "30.174.57.21",
                "Tags": "test_tag"
            }
        ],
        "RequestId": "7426c613-085b-48c4-9257-87a208a8adcc",
        "TaskRequestId": "901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d",
        "TotalCount": 1
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
ResourceNotFound.Instance	实例不存在。

查询消息列表

本页目录：