QueryMessageByMessageId--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

消息队列 Kafka版

QueryMessageByMessageId

最近更新时间：2022.10.18 16:24:27首次发布时间：2022.04.24 15:56:38

调用 QueryMessageByMessageId 可以查询分区中指定 Offset 的消息内容。

使用说明

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 100 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-****	实例 ID。
Topic	String	必选	query_topic	Topic 名称。
Partition	Integer	必选	0	分区编号。
MessageOffset	Integer	必选	0	消息偏移量。
NeedMessageBody	Bool	必选	false	是否需要查询消息内容。 true：需要返回消息内容 false：无需返回消息内容

响应参数

参数	参数类型	说明
IsExist	Bool	false	消息是否仍旧保留在服务端。 true：消息存在。 false：消息不存在。
Message	KafkaMessage	-	查询到的消息内容。详细说明请参考 KafkaMessage。

参数

参数类型

说明

IsExist

Bool

false

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

true：消息存在。
false：消息不存在。

Message

KafkaMessage

查询到的消息内容。详细说明请参考 KafkaMessage。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=QueryMessageByMessageId&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-****",
  "Topic": "query_topic",
  "Partition": 0,
  "MessageOffset": 0,
  "NeedMessageBody": false
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "QueryMessageByMessageId",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "IsExist": false,
    "Message": {
      "InstanceId": "kafka-*****",
      "TopicName": "topic",
      "Partition": 0,
      "MessageOffset": 0,
      "MessageSize": 1023,
      "CreateTime": 0,
      "Key": "name",
      "Body": "hello"
    }
  }
}