You need to enable JavaScript to run this app.
导航
消息队列 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”。

请求参数

参数参数类型是否必选示例值说明
InstanceIdString必选kafka-****实例 ID。
TopicString必选query_topicTopic 名称。
PartitionInteger必选0分区编号。
MessageOffsetInteger必选0消息偏移量。

NeedMessageBody

Bool

必选

false

是否需要查询消息内容。

  • true：需要返回消息内容
  • false：无需返回消息内容

响应参数

参数参数类型说明

IsExist

Bool

false

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

  • true：消息存在。
  • false：消息不存在。
MessageKafkaMessage-查询到的消息内容。详细说明请参考 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"
    }
  }
}