创建投递Ckafka任务

最近更新时间: 2026-09-17 00:06:36

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

创建投递Ckafka任务

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

接口更新时间：2025-08-14 11:57:32。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：CreateConsumer
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
TopicId	是	否	String	投递任务绑定的日志主题 ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
NeedContent	否	否	Bool	是否投递日志的元数据信息，默认为 true。当NeedContent为true时：字段Content有效。当NeedContent为false时：字段Content无效。示例值： false
Content	否	否	ConsumerContent	如果需要投递元数据信息，元数据信息的描述示例值：查看
Ckafka	是	否	Ckafka	CKafka的描述示例值：查看
Compression	否	否	Int64	投递时压缩方式，取值0，2，3。[0：NONE；2：SNAPPY；3：LZ4] 示例值： 0

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
LimitExceeded	超过配额限制。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。

5. 示例

示例1 创建投递Ckafka任务

CLS 日志投递Ckafka之后，您可以对日志进行实时计算后入库。

输入示例

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

{
    "TopicId": "4e7ecda4-3a52-4e0b-bdb8-daf7eb4e6ddb",
    "Ckafka": {
        "Vip": "10.0.0.0",
        "Vport": "8080",
        "InstanceId": "ckafka-id",
        "InstanceName": "ckafka_test",
        "TopicId": "topic-id",
        "TopicName": "topic_test"
    },
    "Content": {
        "EnableTag": true,
        "MetaFields": [
            "__SOURCE__"
        ]
    },
    "NeedContent": true,
    "Compression": 0
}

输出示例

{
    "Response": {
        "RequestId": "4e7ecda4-3a52-4e0b-bdb8-daf7eb4e6ddb"
    }
}