1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
创建ckafka主题
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateTopic。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例Id 示例值：xxx |
| TopicName | 是 | String | 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) 示例值：xxx |
| PartitionNum | 是 | Integer | Partition个数，大于0 示例值：1 |
| ReplicaNum | 是 | Integer | 副本个数，不能多于 broker 数，最大为3 示例值：2 |
| EnableWhiteList | 否 | Integer | ip白名单开关, 1:打开 0:关闭，默认不打开 示例值：0 |
| IpWhiteList.N | 否 | Array of String | Ip白名单列表，配额限制，enableWhileList=1时必选 示例值：["1.1.1.1","2.2.2.2"] |
| CleanUpPolicy | 否 | String | 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。 示例值：delete |
| Note | 否 | String | 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) 示例值：note |
| MinInsyncReplicas | 否 | Integer | 默认为1 示例值：2 |
| UncleanLeaderElectionEnable | 否 | Integer | 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许 示例值：1 |
| RetentionMs | 否 | Integer | 可选参数。消息保留时间，单位ms，当前最小值为60000ms 示例值：60000 |
| SegmentMs | 否 | Integer | Segment分片滚动的时长，单位ms，当前最小为3600000ms 示例值：360000 |
| MaxMessageBytes | 否 | Integer | 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。 示例值：1024 |
| EnableAclRule | 否 | Integer | 预设ACL规则, 1:打开 0:关闭，默认不打开 示例值：0 |
| AclRuleName | 否 | String | 预设ACL规则的名称 示例值：xxx |
| RetentionBytes | 否 | Integer | 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B 示例值：-1 |
| Tags.N | 否 | Array of Tag | 标签列表 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | CreateTopicResp | 返回创建结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建主题
输入示例
https://ckafka.tencentcloudapi.com/?Action=CreateTopic
&InstanceId=xxx
&TopicName=xxx
&PartitionNum=1
&ReplicaNum=2
&<公共请求参数>输出示例
{
"Response": {
"Result": {
"TopicId": "topic-k766ruye"
},
"RequestId": "1305a410-b030-476d-acdf-eba0dfd5323b"
}
}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 | 参数错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id。 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone。 |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.ZoneNotSupport | zone不支持。 |
| LimitExceeded | 超过配额限制。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作。 |