打开Kafka协议消费

最近更新时间:2024-04-26 01:11:42

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

打开Kafka协议消费功能

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:OpenKafkaConsumer。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
FromTopicId String 日志主题ID
示例值:57f5808c-4a55-11eb-b378-0242ac130002
Compression Integer 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0
示例值:0
ConsumerContent KafkaConsumerContent kafka协议消费数据格式

3. 输出参数

参数名称 类型 描述
TopicID String KafkaConsumer 消费时使用的Topic参数
示例值:out-57f5808c-4a55-11eb-b378-0242ac130002
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 打开Kafka协议消费功能

打开Kafka协议消费功能

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenKafkaConsumer
<公共请求参数>

{
    "FromTopicId": "a5ce0c9c-0690-44a5-bc79-5f2190626bd0",
    "Compression": 0
}

输出示例

{
    "Response": {
        "TopicID": "out-a5ce0c9c-0690-44a5-bc79-5f2190626bd0",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ExportConflict 导出任务已经存在。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.ACLFailed ACL校验失败。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。