QueryMessageByMsgId - 根据消息ID进行消息查询--消息队列 RocketMQ版-火山引擎

文档中心

导航

QueryMessageByMsgId - 根据消息ID进行消息查询

最近更新时间：2024.12.11 16:01:49首次发布时间：2023.07.12 16:22:34

调用 QueryMessageByMsgId 查询 Topic 中指定 MessageId 的消息元数据。

使用说明

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

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryMessageByMsgId	要执行的操作，取值：QueryMessageByMsgId。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai81fd122a****	实例 ID。
TopicName	String	是	query_topic	Topic 名称。
MessageId	String	是	FDBDDC420003019700000000000000390017014AE5A51A6D2B75****	消息 ID。

返回参数

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

参数	类型	示例值	描述
MessageInfo	Object	/	指定消息的消息体。

请求示例

POST /?Action=QueryMessageByMsgId&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****",
  "MessageId": "FDBDDC420003019700000000000000390017014AE5A51A6D2B75****",
  "TopicName": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305082031048DEA0CF49FEB5749F703",
        "Action": "QueryMessageByMsgId",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "MessageInfo": {
            "Body": "aGVsbG8gYmFieWhlbGxvIGJhYnloZWxsbyBiYWJ5aGVsbG8gYmFieWhlbGxvIGJhYnloZWxsbyBiYWJ5aGVsbG8gYmFieWhlbGxvIGJhYnloZWxsbyBiYWJ5aGVsbG8gYmFieWhlbGxvIGJhYnloZWxsxxxxxxx",
            "CreateTimestamp": 1683313762,
            "IsExist": true,
            "MessageId": "FDBDDC420003019700000000000000390017014AE5A51A6D2B75****",
            "MessageKey": "",
            "MessageSize": 332,
            "ProducerHost": "100.xx.xx.xx:612xxx",
            "StoreTimestamp": 1683313762,
            "Tag": "",
            "TopicName": "test"
        }
    }
}

错误码

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