查询 Topic 中存储的消息,可通过消息创建时间或者位点来进行查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alikafka:QueryMessage | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 资源的地域 ID。 | cn-hangzhou |
InstanceId | string | 是 | 实例 ID。 | alikafka_pre-cn-mp919o4v**** |
Topic | string | 是 | Topic 名称。 | testkafka |
QueryType | string | 是 | 查询类型取值有两种
| byTimestamp |
Partition | string | 否 | 分区 ID。 | 0 |
Offset | string | 否 | 分区位点。 | 100 |
BeginTime | long | 否 | 查询范围的起始时间戳。单位:毫秒。 | 1672410180000 |
返回参数
示例
正常返回示例
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
}
]
}
错误码
访问错误中心查看更多错误码。