1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
查询日志投递kafka可选项列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLogDeliveryKafkaOptions。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| InstanceID | 否 | String | kafka实例id 示例值：ckafka-xxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceList | Array of CKafkaInstanceInfo | 实例列表 示例值：[ { "InstanceID": "ckafka-ce80kte5", "InstanceName": "云环境", "KafkaVersion": "0.10.2.1", "DiskSize": 300, "VpcId": "vpc-jdi*", "SubnetId": "subnet-1df", "Healthy": 1, "Zone": "广州三区", "Az": "广州", "Bandwidth": 320, "TopicList": [ { "TopicID": "topic-epj9w5yw", "TopicName": "bruteforce_attack" } ], "RouteList": [ { "RouteID": 5427, "Domain": "www.demo.com", "DomainPort": 0, "Vip": "172.16.100.6:9092", "VipType": 3, "AccessType": 0 } ] } ] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogDeliveryKafkaOptions
<公共请求参数>
{
"InstanceID": "ckafka-ce80kte5"
}输出示例
{
"Response": {
"InstanceList": [
{
"InstanceID": "ckafka-ce80k",
"InstanceName": "云环境",
"KafkaVersion": "0.10.2.1",
"DiskSize": 300,
"VpcId": "vpc-sdfd***",
"SubnetId": "subnet-***",
"Healthy": 1,
"Zone": "广州三区",
"Az": "广州",
"Bandwidth": 320,
"TopicList": [
{
"TopicID": "topic-epj9",
"TopicName": "bruteforce_attack"
},
{
"TopicID": "topic-r48k",
"TopicName": "create_snapshot"
}
],
"RouteList": [
{
"RouteID": 5427,
"Domain": "a.yd***",
"DomainPort": 0,
"Vip": "172.100.100.100:9092",
"VipType": 3,
"AccessType": 0
}
]
}
],
"RequestId": "3758d2c5-57d1-471a-b713-ad353665ce62"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
