You need to enable JavaScript to run this app.
导航

QueryDLQMessageByGroupId

最近更新时间2023.07.12 16:22:34

首次发布时间2023.07.12 16:22:34

调用 QueryDLQMessageByGroupId 接口根据时间范围查询指定 Group 的死信消息。

使用说明

此接口用于指定时间范围的死信消息查询,即根据 Group ID 和死信消息产生的时间范围,查询该 Group ID 在某段时间内产生的所有死信消息。按时间范围查询时,会筛选出符合条件的消息列表,查询到的死信消息可能较多。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

GroupId

String

GID_test

死信队列对应的的 Group ID。

  • 创建 Group 时,消息队列 RocketMQ版会自动为其创建一个对应的死信队列。
  • 一个死信队列对应一个 Group ID, 而不是对应单个消费者实例。一个死信队列包含了对应 Group ID 产生的所有死信消息,不论该消息属于哪个 Topic。

QueryStartTimestamp

String

1661320625

消息存储时间中的起始时间戳,单位为秒。
消息存储时间指消息在投递重试达到最大次数后被发送到死信队列的时间。

QueryEndTimestamp

String

1661320682

消息存储时间中的结束时间戳,单位为秒。
消息存储时间指消息在投递重试达到最大次数后被发送到死信队列的时间。

PageNumber

Integer

1

列表的页码,最小值为 1。

PageSize

Integer

10

列表中每一页的条目数量,取值范围为 1~100。

响应参数

参数

参数类型

示例值

说明

DLQMessageList

Array of BasicDLQMessageInfoObject

/

符合查询条件的消息列表。详细信息请参考BasicDLQMessageInfoObject

HasMoreMessage

Bool

true

是否还有更多页的消息。此值为 true 时,您可以再次调用此接口,翻页查询更多消息。

  • true:还有更多页的消息。
  • false:没有更多页的消息。

示例

请求示例

POST /?Action=QueryDLQMessageByGroupId&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai81fd122a****",
  "GroupId": "test",
  "PageNumber": 1,
  "PageSize": 1,
  "QueryStartTimestamp": "1683784892",
  "QueryEndTimestamp": "1683784894"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202305111610394335E858B3A3508D5F6E",
        "Action": "QueryDLQMessageByGroupId",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "DLQMessageList": [
            {
                "CreateTimestamp": 1683784885,
                "IsExist": true,
                "MessageId": "FDBD0FF1CE00003A0000000000000EFE425C18B4AAC23681F242****",
                "MessageKey": "",
                "MessageSize": 143516,
                "ProducerHost": "100.xx.xx.xx:xxxxx",
                "ReconsumeTimes": 1,
                "StoreTimestamp": 1683784893,
                "Tag": ""
            },
            {
                "CreateTimestamp": 1683784884,
                "IsExist": true,
                "MessageId": "FDBD0FF1CE00003A0000000000000EFE425C18B4AAC23681EE4F****",
                "MessageKey": "",
                "MessageSize": 47276,
                "ProducerHost": "100.xx.xx.xx:xxxxx",
                "ReconsumeTimes": 1,
                "StoreTimestamp": 1683784893,
                "Tag": ""
            }
        ],
        "HasMoreMessage": false
    }
}