1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于获取Kafka数据订阅任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeKafkaRecharges。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TopicId | 是 | String | 日志主题 ID 示例值:6bf3355c-3c88-4566-89c8-76c3ca37bae9 |
Id | 否 | String | 导入配置ID |
Status | 否 | Integer | 状态 status 1: 运行中, 2: 暂停... 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Infos | Array of KafkaRechargeInfo | KafkaRechargeInfo 信息列表 |
TotalCount | Integer | Kafka导入信息总条数 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Kafka导入配置信息
获取Kafka导入配置信息
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKafkaRecharges
<公共请求参数>
{
"TopicId": "abc",
"Status": 1
}
输出示例
{
"Response": {
"Infos": [
{
"Id": "86076b49-1234-4321-ab09-a5d7e7972825",
"TopicId": "957f4aed-1234-4321-b98b-c3c806f9e71b",
"Name": "task-test",
"KafkaType": 1,
"KafkaInstance": "",
"ServerAddr": "kafkaconsumer-ap-chongqing.aaa.com:1234",
"IsEncryptionAddr": true,
"Protocol": {
"Protocol": "sasl_plaintext",
"Mechanism": "PLAIN",
"UserName": "1234567-8146-461f-a951-348c4748f63d",
"Password": "AKIDxxxxx#abcdefjxxxx"
},
"UserKafkaTopics": "1256238147-f3061593-cd5b-4321-1234-3ba507d43301",
"ConsumerGroupName": "",
"Status": 1,
"Offset": -2,
"CreateTime": "2023-04-03 19:46:52",
"UpdateTime": "2023-04-04 11:41:54",
"LogRechargeRule": {
"RechargeType": "json_log",
"LogRegex": "",
"UnMatchLogSwitch": true,
"UnMatchLogKey": "LogParseFailure",
"UnMatchLogTimeSrc": 0,
"EncodingFormat": 0,
"DefaultTimeSwitch": true,
"DefaultTimeSrc": 0,
"TimeKey": "",
"TimeRegex": "",
"TimeFormat": "",
"TimeZone": "UTC-11:00",
"Metadata": [
"kafka_topic",
"kafka_partition",
"kafka_offset",
"kafka_timestamp"
],
"Keys": []
}
}
],
"TotalCount": 1,
"RequestId": "7101f52f-a442-475b-90a3-4855133fefbf"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.TopicConflict | 指定日志集下已经有同名的日志主题。 |
LimitExceeded | 超过配额限制。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ACLFailed | ACL校验失败。 |
OperationDenied.AccountDestroy | 账户已销毁。 |
OperationDenied.AccountIsolate | 账户欠费。 |
OperationDenied.AccountNotExists | 账户不存在。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.TopicNotExist | 日志主题不存在。 |