1. 接口描述
接口请求域名:
ckafka.api.qcloud.com
本接口(CreateTopic)用于在消息队列 CKafka 实例下创建主题。2. 输入参数
参数名称 | 必选 | 类型 | 描述 |
instanceId | 是 | String | 实例 ID。 |
topicName | 是 | String | 主题名称,是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线 - 。 |
partitionNum | 是 | Int | Partition 个数,大于0。 |
replicaNum | 是 | Int | 副本个数,不能多于 broker 数,最大为3。 |
note | 否 | String | 主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线 - 。 |
enableWhiteList | 否 | Int | IP 白名单开关,1:打开 0:关闭,默认不打开。 |
ipWhiteList.n | 否 | String | IP 白名单列表,配额限制,enableWhileList=1 时必选。 |
cleanUpPolicy | 否 | String | 清理日志策略,日志清理模式,默认为"delete"。"delete":日志按保存时间删除,"compact":日志按 key 压缩,"compact, delete":日志按 key 压缩且会按保存时间删除。 |
minInsyncReplicas | 否 | Int | 默认为1。 |
uncleanLeaderElectionEnable | 否 | Int | 默认为0。 0表示 false。 1表示 true。 |
retentionMs | 否 | Int | 消息保留时间,单位:ms,当前最小值为60000ms。 |
segmentMs | 否 | Int | Segment 分片滚动的时长,单位:ms,当前最小为86400000ms。 |
3. 输出参数
参数名称 | 类型 | 描述 |
topicId | String | 主题 ID |
4. 示例
输入:
https://domain/v2/index.php?Action=CreateTopic&<公共请求参数>
输出:
{"code" : 0,"codeDesc":"Success","message" : "ok","topicId" : "topic-xxoo234"}