首页 >消息队列Kafka版 >API参考指南 >API目录 >Topic >CreateTopic - 创建Topic

CreateTopic - 创建Topic

调用CreateTopic创建Topic。

接口说明

  • 单用户请求频率限制为1 QPS。

  • 每个实例下最多可创建的Topic数量与您所购买的实例规格相关。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

alikafka_pre-cn-mp919o4v****
Topicstring

Topic的名称。

  • 只能包含字母、数字、下划线(_)和短划线(-)。

  • 长度限制为3~64字符,多于64个字符将被自动截取。

  • Topic名称一旦创建,将无法修改。

alikafka_topic_test
Remarkstring

Topic的备注。

  • 只能包含字母、数字、下划线(_)、短划线(-)。

  • 长度为3~64字符。

alikafka_topic_test
RegionIdstring

Topic所在实例的地域ID。

cn-hangzhou
CompactTopicboolean

Topic的存储引擎配置为Local存储时,会配置日志清理策略。取值:

  • false:delete清理策略。
  • true:compact清理策略。
false
PartitionNumstring

Topic的分区数。

  • 分区数限制1~360。

  • 控制台会根据实例规格提供不同的配置建议,请根据控制台建议配置分区数,减少数据倾斜风险。

  • 特殊需求请提交工单。

12
LocalTopicboolean

Topic的存储引擎。取值:

  • false:云存储。
  • true:Local存储。
false
ReplicationFactorLong

Topic的副本数。

  • 仅当LocalTopic值为true<props="local_disk">,或规格类型开源版(本地盘),才可以指定该参数。

  • 副本数限制1~3。

说明副本数为1时,有数据丢失的风险,请谨慎设置。
3
MinInsyncReplicasLong

最小ISR同步副本数。

  • 仅当LocalTopic值为true<props="local_disk">,或规格类型开源版(本地盘),才可以指定该参数。

  • 取值需小于Topic副本数。

  • 同步副本数限制1~3。

1
Configobject

补充配置。

  • 必须为JSON格式。

  • 目前仅支持Key为replications。表示Topic副本数,取值类型为Integer,取值限制1~3。

  • 仅当LocalTopic值为true<props="local_disk">,或规格类型开源版(本地盘),才可以指定该参数。

说明如果该参数中指定了replications,指定的ReplicationFactor参数不再生效。
{"replications": 3}

返回参数

名称类型描述示例值
object
Codeinteger

返回码。返回200代表成功。

200
Messagestring

返回信息。

operation success
RequestIdstring

请求的ID。

9C0F207C-77A6-43E5-991C-9D98510A****
Successboolean

调用是否成功。

true

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTopic
&InstanceId=alikafka_pre-cn-mp919o4v****
&RegionId=cn-hangzhou
&Remark=alikafka_topic_test
&Topic=alikafka_topic_test
&<公共请求参数>

正常返回示例

JSON格式

{
    "RequestId": "9C0F207C-77A6-43E5-991C-9D98510A****",
    "Message": "operation success",
    "Code": 200,
    "Success": true
}

XML格式

<CreateTopicResponse>
    <RequestId>9C0F207C-77A6-43E5-991C-9D98510A****</RequestId>
    <Message>operation success</Message>
    <Code>200</Code>
    <Success>true</Success>
</CreateTopicResponse>

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-11-17OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ReplicationFactor
    新增入参:MinInsyncReplicas
    新增入参:Config
阿里云首页 消息队列Kafka版 相关技术圈