Kafka数据订阅日志预览

最近更新时间:2024-04-22 01:12:08

我的收藏

1. 接口描述

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

本接口用于预览Kafka数据订阅任务客户日志信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PreviewKafkaRecharge。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
PreviewType Integer 预览类型,1:源数据预览;2:导出结果预览。
示例值:1
KafkaType Integer 导入Kafka类型,0:腾讯云CKafka;1:用户自建Kafka。
示例值:1
UserKafkaTopics String 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
最多支持100个。
示例值:topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111
Offset Integer 导入数据位置,-2:最早;-1:最晚。
示例值:-1
KafkaInstance String 腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。
示例值:ckafka-k9m5vj11
ServerAddr String 服务地址。
KafkaType为1时ServerAddr必填。
示例值:192.168.0.1:9095或test.cls.tencentyun.com:9095
IsEncryptionAddr Boolean ServerAddr是否为加密连接。
KafkaType为1时有效。
示例值:true
Protocol KafkaProtocolInfo 加密访问协议。
KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
ConsumerGroupName String 用户Kafka消费组
示例值:cls-xxxxx
LogRechargeRule LogRechargeRuleInfo 日志导入规则

3. 输出参数

参数名称 类型 描述
LogSample String 日志样例,PreviewType为2时返回
LogData String 日志预览结果
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 Kafka导入数据预览

源数据预览

输入示例

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

{
    "PreviewType": 1,
    "KafkaType": 0,
    "KafkaInstance": "ckafka-k9m5vj75",
    "UserKafkaTopics": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111",
    "ConsumerGroupName": "",
    "Offset": -1
}

输出示例

{
    "Response": {
        "RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx",
        "LogData": "rmap[AvailIndexTraffic:0 AvailStore:0 ClusterAvailableTrafficCapacity:0...",
        "LogSample": ""
    }
}

示例2 Kafaka导入数据预览

导出结果预览

输入示例

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

{
    "PreviewType": 2,
    "KafkaType": 0,
    "KafkaInstance": "ckafka-l4rped7z",
    "UserKafkaTopics": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111",
    "ConsumerGroupName": "",
    "Offset": -2,
    "LogRechargeRule": {
        "RechargeType": "minimalist_log",
        "LogRegex": "",
        "UnMatchLogSwitch": true,
        "UnMatchLogKey": "LogParseFailure",
        "UnMatchLogTimeSrc": 0,
        "EncodingFormat": 0,
        "DefaultTimeSwitch": true,
        "DefaultTimeSrc": 0,
        "TimeKey": "",
        "TimeRegex": "",
        "TimeFormat": "",
        "TimeZone": "UTC+08:00",
        "Metadata": [
            "kafka_topic",
            "kafka_partition",
            "kafka_offset",
            "kafka_timestamp"
        ],
        "Keys": []
    }
}

输出示例

{
    "Response": {
        "LogSample": "{\"x-intranet-proxy-region\":\"sh\",\"x-intranet-proxy-socket-local-address\":\"::ffff:11.179.111.111\",\"x-intranet-proxy-socket-local-port\":\"8443\"",
        "LogData": "{\"__CONTENT__\":\"{\\\"x-intranet-proxy-region\\\":\\\"sh\\\",\\\"x-intranet-proxy-socket-local-address\\\":\\\"::ffff:11.179.111.111\\\",\\\"x-intranet-proxy-socket-local-port\\\":\\\"8443\\\"",
        "RequestId": "d3218ba6-4d98-480a-a97b-8db0ae87ef31"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。