日志服务 Kafka服务集群连通性校验-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口用于校验Kafka服务集群是否可以正常访问

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CheckRechargeKafkaServer。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
KafkaType	是	Integer	导入Kafka类型，0: 腾讯云CKafka；1: 用户自建Kafka。示例值：0
KafkaInstance	否	String	腾讯云CKafka实例ID。 KafkaType为0时，KafkaInstance必填示例值：ckafka-5kysm8
ServerAddr	否	String	服务地址。 KafkaType为1时，ServerAddr必填示例值：192.168.0.1:9095或test.cls.tencentyun.com:9095
IsEncryptionAddr	否	Boolean	ServerAddr是否为加密连接，默认值false。当KafkaType为1用户自建kafka时生效。示例值：true
Protocol	否	KafkaProtocolInfo	加密访问协议。KafkaType参数为1并且IsEncryptionAddr参数为true时必填。

3. 输出参数

参数名称	类型	描述
Status	Integer	Kafka集群可访问状态，0：可正常访问 ... 注意：此字段可能返回 null，表示取不到有效值。示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 校验用户输入Kafka服务地址是否可访问

校验用户输入Kafka服务地址是否可访问

输入示例

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

{
    "KafkaType": 1,
    "ServerAddr": "est.cls.tencentyun.com:9095",
    "IsEncryptionAddr": false
}

输出示例

{
    "Response": {
        "RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx",
        "Status": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。

Kafka服务集群连通性校验

本页目录：