QueryDLQMessageById - 根据MessageID查询Group死信消息--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

QueryDLQMessageById - 根据MessageID查询Group死信消息

最近更新时间：2024.11.18 10:27:31首次发布时间：2023.07.12 16:22:34

调用 QueryDLQMessageById 可以查询指定 MessageID 的死信消息。

使用说明

此接口用于查询指定 Group ID 下指定 Message ID 的消息。按消息 ID 查询时，可以精确到某一条消息，适用于精确查询的情况。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryDLQMessageById	要执行的操作，取值：QueryDLQMessageById。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例ID
GroupId	String	是	GID_test	死信队列对应的的 Group ID。创建 Group 时，消息队列 RocketMQ版会自动为其创建一个对应的死信队列。一个死信队列对应一个 Group ID，而不是对应单个消费者实例。一个死信队列包含了对应 Group ID 产生的所有死信消息，不论该消息属于哪个 Topic。
MessageId	String	是	0	需要查询的消息ID

返回参数

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

参数	类型	示例值	描述
DLQMessageInfo	Object	/	符合查询条件的消息。

请求示例

POST /?Action=QueryDLQMessageById&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": "GID_test",
  "MessageId": "FDBD0FF1CE00003A0000000000000EFE425C18B4AAC23681F242****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023051116074104FDC23D6C0B568B8141",
        "Action": "QueryDLQMessageById",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "DLQMessageInfo": {
            "CreateTimestamp": 1683784885,
            "IsExist": true,
            "MessageId": "FDBD0FF1CE00003A0000000000000EFE425C18B4AAC23681F242****",
            "MessageKey": "",
            "MessageSize": 143516,
            "ProducerHost": "100.xx.xx.xx:61***",
            "ReconsumeTimes": 1,
            "StoreTimestamp": 1683784893,
            "Tag": ""
        }
    }
}

错误码

公共错误码请参见公共错误码文档。