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

使用说明

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

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：QueryDLQMessageByGroupId

要执行的操作，取值：QueryDLQMessageByGroupId。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-cnai1f0c29ca****

实例 ID。

GroupId string 必选示例值：GID_test

死信队列对应的的 Group ID。

一个死信队列对应一个 Group ID，而不是对应单个消费者实例。

一个死信队列包含了对应 Group ID 产生的所有死信消息，不论该消息属于哪个 Topic。

QueryStartTimestamp string 必选示例值：1661320625

消息存储时间中的起始时间戳，单位为秒。

消息存储时间指消息在投递重试达到最大次数后被发送到死信队列的时间。

QueryEndTimestamp string 必选示例值：1661320682

消息存储时间中的结束时间戳，单位为秒。

消息存储时间指消息在投递重试达到最大次数后被发送到死信队列的时间。

PageNumber integer 必选示例值：1

列表的页码，最小值为 1。其中列表中每一页的条目数量固定为 16。

Refresh boolean 可选示例值：true

是否强制刷新。默认值为false。

true：强制刷新消息缓存。若查询范围发生变化，请设置为true。

false：不强制刷新消息缓存。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

DLQMessageList object[] 示例值：/

符合查询条件的消息列表。

MessageId string 示例值：FDBDDC420003019700000000000000390017014AE5A51A6D2B75****

消息 ID。

IsExist boolean 示例值：true

消息是否仍旧保留在服务端。

true：消息存在。

false：消息不存在。

Tag string 示例值：FDBD0

消息 Tag。

MessageKey string 示例值：FDBD0

消息 Key。为了避免特殊字符的影响，消息 Key 将会以 Base64 的编码的方式返回，需要通过 Base64 解码后才能查看。

MessageSize integer 示例值：47276

消息大小，单位为 Byte。

ProducerHost string 示例值：100.xx.xx.xx:xxxx

生产者实例地址。

ReconsumeTimes integer 示例值：1

消息重试消费的次数，即手动重发死信消息后，该消息再次进入死信队列的次数。

CreateTimestamp long 示例值：1683784884

消息生成的时间戳，单位为秒。

StoreTimestamp long 示例值：1683784893

消息被服务端存储的时间戳，单位为秒。

HasMoreMessage boolean 示例值：true

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

true：还有更多页的消息。

false：没有更多页的消息。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	OperationDenied_InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

消息队列 RocketMQ版