文档

CreateTopic - 创建Topic

更新时间:

创建Topic。

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alikafka:CreateTopicWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
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,或规格类型开源版(本地盘),才可以指定该参数。

  • 副本数限制 1~3。

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

最小 ISR 同步副本数。

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

  • 取值需小于 Topic 副本数。

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

1
Configstring

补充配置。

  • 必须为 JSON 格式。

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

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

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

标签列表。

Keystring

资源的标签键。

  • N 为 1~20。

  • 如果为空,则匹配所有标签键。

  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。

  • N 为 1~20。

  • 可以为空。

  • 最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。

FinanceJoshua

返回参数

名称类型描述示例值
object
Codeinteger

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

200
Messagestring

返回信息。

operation success
RequestIdstring

请求的 ID。

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

调用是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-01-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-10-28OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
2021-11-17OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ReplicationFactor
    新增入参:MinInsyncReplicas
    新增入参:Config
  • 本页导读 (1)
文档反馈