1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
获取kafka投递信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLogKafkaDeliverInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KafkaEnvName | String | 实例环境 示例值：主机安全测试环境 |
| KafkaId | String | 实例id 示例值：ckafka-ce80kte5 |
| Zone | String | 地域 示例值：广州 |
| Az | String | 可用区 示例值：广州三区 |
| VpcId | String | 所属网络 |
| SubnetId | String | 所在子网 |
| AccessType | Integer | 接入方式，1公网域名接入，2支撑环境接入 示例值：1 |
| AccessAddr | String | 接入地址 示例值：192.168.1.1:80 |
| DeliverStatus | Integer | 投递状态，1：健康，2：告警，3：异常 示例值：1 |
| InsVersion | String | kafka版本 示例值：0.10.2.1 |
| BandWidth | Integer | 峰值带宽 示例值：1200 |
| DiskSize | Integer | 磁盘容量 示例值：2500 |
| Username | String | 用户名 |
| DeliverTypeDetails | Array of DeliverTypeDetails | xx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取kafka投递信息
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogKafkaDeliverInfo
<公共请求参数>
{}输出示例
{
"Response": {
"KafkaEnvName": "abc",
"KafkaId": "abc",
"Zone": "abc",
"Az": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"AccessType": 1,
"AccessAddr": "abc",
"DeliverStatus": 1,
"InsVersion": "abc",
"BandWidth": 0,
"DiskSize": 0,
"Username": "abc",
"DeliverTypeDetails": [
{
"SecurityType": 1,
"LogType": [
0
],
"TopicId": "abc",
"TopicName": "abc",
"Switch": 1,
"Status": 1,
"ErrInfo": "abc",
"StatusTime": 0
}
],
"RequestId": "abc"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。