文档

QueryMessage - 查询 Topic 消息

更新时间:

查询 Topic 中存储的消息,可通过消息创建时间或者位点来进行查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alikafka:QueryMessageRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

资源的地域 ID。

cn-hangzhou
InstanceIdstring

实例 ID。

alikafka_pre-cn-mp919o4v****
Topicstring

Topic 名称。

testkafka
QueryTypestring

查询类型取值有两种

  • byOffset:通过位点来进行查询。选择位点查询则需要填入分区 ID 和分区位点参数。

  • byTimestamp:通过时间来进行查询。选择时间查询则需要填入 BeginTime 参数。

byTimestamp
Partitionstring

分区 ID。

0
Offsetstring

分区位点。

100
BeginTimelong

查询范围的起始时间戳。单位:毫秒。

1672410180000

返回参数

名称类型描述示例值
object
Codeinteger

返回码。返回 200 代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求 ID。

ABA4A7FD-E10F-45C7-9774-A5236015****
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true
MessageListobject []

查询到的消息结果

Topicstring

Topic 名称。

dqc_test2
Partitionlong

分区 ID。

0
Offsetlong

分区位点。

1
Timestamplong

消息创建时间。用 UNIX 时间戳表示,单位:秒。

1705482172640
TimestampTypestring

时间类型

CreateTime
Checksumlong

链码校验值

0
SerializedKeySizeinteger

key 序列化后的大小,单位为 Bytes。

11
SerializedValueSizeinteger

value 序列化后的大小,单位为 Bytes。

20
Keystring

消息的 key。

this is key
Valuestring

消息的 value

Welcome to Ali kafka
KeyTruncatedboolean

key 是否截断。

false
ValueTruncatedboolean

value 是否截断。

false
TruncatedKeySizeinteger

key 截断消息的大小,单位为 Bytes。

  • 返回消息超过 10M 才会截断。
0
TruncatedValueSizeinteger

value 截断消息的大小,单位为 Bytes。

  • 返回消息超过 10M 才会截断。
0

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015****",
  "Success": true,
  "MessageList": [
    {
      "Topic": "dqc_test2",
      "Partition": 0,
      "Offset": 1,
      "Timestamp": 1705482172640,
      "TimestampType": "CreateTime",
      "Checksum": 0,
      "SerializedKeySize": 11,
      "SerializedValueSize": 20,
      "Key": "this is key",
      "Value": "Welcome to Ali kafka",
      "KeyTruncated": false,
      "ValueTruncated": false,
      "TruncatedKeySize": 0,
      "TruncatedValueSize": 0
    }
  ]
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈