根据位点查询消息列表
最近更新时间: 2025-02-18 17:50:22
1. 接口描述
接口请求域名： ckafka.api3.fincloud.tencent.cn。
根据位点查询消息列表
默认接口请求频率限制：100次/秒。
接口更新时间：2022-07-21 11:55:15。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：FetchMessageListByOffset |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-08-19 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例Id |
| Topic | 是 | 否 | String | 主题名 |
| Partition | 是 | 否 | Uint64 | 分区id |
| Offset | 是 | 否 | Uint64 | 位点信息 |
| SinglePartitionRecordNumber | 否 | 否 | Uint64 | 最大查询条数，默认20，最大20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | ConsumerRecord | 返回结果。注意，列表中不返回具体的消息内容（key、value），如果需要查询具体消息内容，请使用FetchMessageByOffset接口 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue.WrongAction | |
| InvalidParameterValue.InstanceNotExist | |
| UnauthorizedOperation | |
| InternalError | |
| ResourceUnavailable |