调用 PreviewTopicData 接口，预览目标 Topic 的消息数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | PreviewTopicData | 要执行的操作，取值：PreviewTopicData。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
PreviewType | String | 是 | OFFSET | 消息数据的预览方式，取值如下：
|
TopicId | String | 是 | 677bb****b1e406797e87e309785c4e6 | Topic ID。 |
RelativeValue | Long | 是 | 38299 | 检索的起始位点。 |
EndValue | Long | 否 | 48299 | 检索的终止位点。 |
PageNumber | Integer | 否 | 1 | 页码。 |
PageSize | Integer | 否 | 100 | 每页展示的数据条数。 |
Partitions | Array of Integer | 否 | 0 | 分区序号。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Items | Array of Object | - | 返回的消息详情。 |
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 } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。