创建主题

最近更新时间:2020-03-04 17:55:52

1. 接口描述

接口请求域名: ckafka.tencentcloudapi.com 。

创建ckafka主题

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:ckafka.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTopic。
Version String 公共参数,本接口取值:2019-08-19。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例Id
TopicName String 主题名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
PartitionNum Integer Partition个数,大于0
ReplicaNum Integer 副本个数,不能多于 broker 数,最大为3
EnableWhiteList Integer ip白名单开关, 1:打开 0:关闭,默认不打开
IpWhiteList.N Array of String Ip白名单列表,配额限制,enableWhileList=1时必选
CleanUpPolicy String 清理日志策略,日志清理模式,默认为"delete"。"delete":日志按保存时间删除,"compact":日志按 key 压缩,"compact, delete":日志按 key 压缩且会按保存时间删除。
Note String 主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
MinInsyncReplicas Integer 默认为1
UncleanLeaderElectionEnable Integer 是否允许未同步的副本选为leader,false:不允许,true:允许,默认不允许
RetentionMs Integer 可消息选。保留时间,单位ms,当前最小值为60000ms
SegmentMs Integer Segment分片滚动的时长,单位ms,当前最小为3600000ms

3. 输出参数

参数名称 类型 描述
Result CreateTopicResp 返回创建结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InstanceNotExist 实例不存在。
InvalidParameterValue.RepetitionValue 已存在相同参数。
InvalidParameterValue.SubnetIdInvalid 无效的子网id
InvalidParameterValue.SubnetNotBelongToZone 子网不属于zone
InvalidParameterValue.VpcIdInvalid 无效的 Vpc Id
InvalidParameterValue.WrongAction Action参数取值错误。
InvalidParameterValue.ZoneNotSupport zone不支持
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.BatchDelInstanceLimit 批量删除实例限制
UnsupportedOperation.OssReject Oss拒绝该操作