文档中心

云原生消息引擎

Topic 管理

PreviewTopicData - 预览 Topic 数据

调用 PreviewTopicData 接口，预览目标 Topic 的消息数据。

请求说明

请求方式：GET

请求地址：https://open.volcengineapi.com?Action=PreviewTopicData&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：PreviewTopicData

要执行的操作，取值：PreviewTopicData。

Version string 必选示例值：2023-06-01

API的版本，取值：2023-06-01。

PreviewType string 必选示例值：OFFSET

消息数据的预览方式，取值如下：

TIMESTAMP：根据时间点预览。

OFFSET：根据消费位点预览。

InstanceId string 必选示例值：o-00o0shxfhzl3

实例ID

TopicName string 必选示例值：topic-1

Topic名称

RelativeValue long 必选示例值：38299

检索的起始位点。

EndValue long 可选示例值：48299

检索的终止位点。

PageNumber integer 可选示例值：1

页码。

PageSize integer 可选示例值：100

每页展示的数据条数。

Partitions integer[] 可选示例值：0

分区序号。

返回参数

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

Items object[] 示例值：\-

返回的消息详情。

Key string 示例值：KeyA

消息 Key。

Value string 示例值：This is a test message.

消息内容。

Offset long 示例值：38300

消息位置偏移量。

Timestamp long 示例值：1668412911156

消息时间戳。

TopicName string 示例值：topic-1

Topic 名称。

PartitionId integer 示例值：0

分区序号。

Header object[]

消息头

key string

header key

value string

header value

请求示例

POST /?Action=PreviewTopicData&Version=2023-06-01&&TopicId=677bb****b1e406797e87e309785c4e6&PreviewType=OFFSET&RelativeValue=38299&Partitions=0 HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241112T082520Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=AK********/20241112/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********​
​
{}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2024110421395620201302421086****",​
    "Action": "PreviewTopicData",​
    "Version": "2023-06-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Items": [​
      {​
        "Key": "KeyA",​
        "Value": "This is a test message.",​
        "Header": [],​
        "Offset": 0,​
        "Timestamp": 1668412911156,​
        "TopicName": "topic-1",​
        "PartitionId": 0​
      }​
    ]​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

最近更新时间：2025.09.04 17:24:44

这个页面对您有帮助吗？

有用

无用