创建主题

最近更新时间:2019-07-17 22:34:14

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"
  }
目录