QueryMessageByMsgKey - 按MessageKey查询消息--消息队列 RocketMQ版-火山引擎

文档中心

导航

QueryMessageByMsgKey - 按MessageKey查询消息

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

调用 QueryMessageByMsgKey 可以查询 Topic 中指定 MessageKey 的消息元数据。

使用说明

成功接入消息队列 RocketMQ版之后，如果生产环境的消息收发不符合预期，可以通过消息查询功能查看服务端的详细消息内容，确认服务端的消息详情是否与生产端或消费端完全一致，排查消息生产或消费问题。此接口用于按消息 ID 查询消息。按消息 ID 查询时，可以精确到某一条消息，适用于需要精确查询的场景。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryMessageByMsgKey	要执行的操作，取值：QueryMessageByMsgKey。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
TopicName	String	是	my_topic	Topic 名称。
MessageKey	String	是	demo-key	消息 Key。

返回参数

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

参数	类型	示例值	描述
HasMoreMessage	Boolean	true	是否还有更多页的消息。此值为 true 时，您可以再次调用此接口，翻页查询更多消息。 true：还有更多页的消息。 false：已返回全部消息。
MessageList	Array of Object	/	符合查询条件的消息列表。

请求示例

POST /?Action=QueryMessageByMsgKey&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****",
  "TopicName": "test",
  "MessageKey": "httpmodule"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308241551550224694212F450AFFC88",
        "Action": "QueryMessageByMsgKey",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "HasMoreMessage": false,
        "MessageList": [
            {
                "Body": "aHR0cG1vZHVsZQo=",
                "CreateTimestamp": 1692863494,
                "IsExist": true,
                "MessageId": "AC1A382700010000000079d9737000c0",
                "MessageKey": "httpmodule",
                "MessageSize": 206,
                "ProducerHost": "172.**.**.**:56274",
                "StoreTimestamp": 1692863494,
                "Tag": "",
                "TopicName": "test"
            }
        ]
    }
}

错误码

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