创建主题
最近更新时间: 2025-02-18 17:50:22
1. 接口描述
接口请求域名： ckafka.api3.fincloud.tencent.cn。
创建ckafka主题
默认接口请求频率限制：100次/秒。
接口更新时间：2020-03-02 18:33:15。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateTopic |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-08-19 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例Id |
| TopicName | 是 | 否 | String | 主题名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) |
| PartitionNum | 是 | 否 | Int64 | Partition个数，大于0 |
| ReplicaNum | 是 | 否 | Int64 | 副本个数，不能多于 broker 数，最大为3 |
| EnableWhiteList | 否 | 否 | Int64 | ip白名单开关, 1:打开 0:关闭，默认不打开 |
| IpWhiteList | 否 | 否 | Array of String | Ip白名单列表，配额限制，enableWhileList=1时必选 |
| CleanUpPolicy | 否 | 否 | String | 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。 |
| Note | 否 | 否 | String | 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) |
| MinInsyncReplicas | 否 | 否 | Int64 | 默认为1 |
| UncleanLeaderElectionEnable | 否 | 否 | Int64 | 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许 |
| RetentionMs | 否 | 否 | Int64 | 可消息选。保留时间，单位ms，当前最小值为60000ms |
| SegmentMs | 否 | 否 | Int64 | Segment分片滚动的时长，单位ms，当前最小为3600000ms |
| MaxMessageBytes | 否 | 否 | Int64 | 主题消息最大值，单位为 Byte，最大值为12582912Byte（即12MB）。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | CreateTopicResp | 返回创建结果 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue.RepetitionValue | |
| InvalidParameterValue.WrongAction | |
| InvalidParameterValue.InstanceNotExist | |
| UnauthorizedOperation | |
| UnsupportedOperation.OssReject | |
| InvalidParameterValue.SubnetNotBelongToZone | |
| InvalidParameterValue.VpcIdInvalid | |
| InvalidParameterValue.SubnetIdInvalid | |
| InvalidParameterValue.ZoneNotSupport | |
| UnsupportedOperation.BatchDelInstanceLimit | |
| InternalError | |
| ResourceUnavailable |