1. 接口描述
接口请求域名: ckafka.tencentcloudapi.com 。
根据时间戳查询消息列表
默认接口请求频率限制:1次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:ckafka.ap-shanghai-fsi.tencentcloudapi.com。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:FetchMessageListByTimestamp。 |
Version | 是 | String | 公共参数,本接口取值:2019-08-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例Id |
Topic | 是 | String | 主题名 |
Partition | 是 | Integer | 分区id |
StartTime | 否 | Integer | 查询开始时间,13位时间戳 |
SinglePartitionRecordNumber | 否 | Integer | 最大查询条数,默认20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Array of ConsumerRecord | 返回结果 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 消息查询
输入示例
https://ckafka.tencentcloudapi.com/?Action=FetchMessageListByTimestamp
&InstanceId=xxx
&Topic=xxx
&Partition=1
&StartTime=1
&SinglePartitionRecordNumber=20
&<公共请求参数>
输出示例
{
"Response": {
"Result": [
{
"Topic": "xxx",
"Partition": 2,
"Offset": 1,
"Key": "xxx",
"Value": "xxx",
"Timestamp": 1
},
{
"Topic": "xxx",
"Partition": 2,
"Offset": 2,
"Key": "xxx",
"Value": "xxx",
"Timestamp": 1
}
],
"RequestId": "62d589e0-53d5-47e0-95ff-237c48b8fb77"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |