You need to enable JavaScript to run this app.
导航
QueryMessageByTimestamp
最近更新时间:2024.06.05 15:29:11首次发布时间:2024.06.05 15:29:11

调用 QueryMessageByTimestamp 接口,可以查询分区中指定时间范围内的消息元数据。

使用说明

此接口用于查询分区中指定时间范围内的消息元数据。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

kafka-cnngbnntswg1****

实例 ID。

TopicName

String

query_topic

Topic 名称。

PartitionId

Integer

0

分区编号。设置为-1时表示查询全部分区。

QueryStartTimestamp

String

1661320625000

需要查询的起始时间。Unix 时间戳格式,单位为毫秒。

QueryEndTimestamp

String

1661320682000

需要查询的结束时间。Unix 时间戳格式,单位为毫秒。

Refresh

Bool

false

是否强制刷新,默认为false。

  • false:不强制刷新消息缓存。
  • true:强制刷新消息缓存。

说明

当时间范围内有新消息写入时,可能需要刷新缓存才能正常查询到。

PageNumber

Integer

1

列表的页码,最小值为 1。

PageSize

Integer

10

列表中每一页的条目数量,取值范围为 1~100。

SortOrder

String

Asc

查询结果的排序方式,默认为Asc。

  • Asc:按分区和消息位点进行升序排列。
  • Desc:按分区和消息位点进行降序排列。

响应参数

参数

参数类型

示例值

说明

MessageList

Array of 数据结构

符合查询条件的消息列表。

HasMoreMessage

Bool

true

是否还有更多页的消息。

  • true:还有更多页的消息。
  • false:没有更多页的消息。

如果指定时间段内消息数量超出指定的 PageSize,消息队列 Kafka 版会分页返回数据。此参数用于展示当前返回的消息是否为全部符合条件的消息合集。

示例

请求示例

POST /?Action=QueryMessageByTimestamp&Version=2022-05-01 HTTP/1.1
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-cnaxxxxx",
  "TopicName": "test-topic",
  "PartitionId": 0,
  "QueryStartTimestamp": 1717415062840,
  "QueryEndTimestamp": 1717415962840,
  "PageNumber": 1,
  "PageSize": 16,
  "Refresh": false
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2024060511024265745BEBEC5C4***",
        "Action": "QueryMessageByTimestamp",
        "Version": "2022-05-01",
        "Service": "kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "HasMoreMessage": false,
        "MessageList": [
            {
                "CreateTime": 1717556541777,
                "Key": "doc-key",
                "Message": "test-message1",
                "MessageOffset": 0,
                "MessageSize": 13,
                "PartitionId": 0,
                "TopicName": "test-topic"
            },
            {
                "CreateTime": 1717556557043,
                "Key": "doc-key",
                "Message": "test-message2",
                "MessageOffset": 1,
                "MessageSize": 13,
                "PartitionId": 0,
                "TopicName": "test-topic"
            }
        ]
    }
}