Kafka实例创建Topic
功能介绍
该接口用于向Kafka实例创建Topic。
URI
POST /v2/{project_id}/instances/{instance_id}/topics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 最小长度：1 最大长度：64 |
|
instance_id |
是 |
String |
实例ID。 最小长度：1 最大长度：64 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
topic名称，长度为4-64，以字母开头且只支持大小写字母、中横线、下划线、点以及数字。 最小长度：3 最大长度：200 |
|
replication |
否 |
Integer |
副本数，配置数据的可靠性。 取值范围：1-3。 最小值：1 最大值：3 |
|
sync_message_flush |
否 |
Boolean |
是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 |
|
partition |
否 |
Integer |
topic分区数，设置消费的并发数。取值范围：。 最小值：1 最大值：100 |
|
sync_replication |
否 |
Boolean |
是否开启同步复制，开启后，客户端生产消息时相应的也要设置acks=-1，否则不生效，默认关闭。 |
|
retention_time |
否 |
Integer |
消息老化时间。默认值为72。取值范围1-720，单位小时。 |
|
topic_other_configs |
否 |
Array of topic_other_configs objects |
topic配置 |
|
topic_desc |
否 |
String |
topic描述 最小长度：0 最大长度：200 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
topic名称。 最小长度：3 最大长度：200 |
|
name |
String |
topic名称。 最小长度：3 最大长度：200 |
请求示例
创建一个Topic，Topic名称为test01。
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
{
"id" : "test01",
"partition" : 3,
"replication" : 3,
"retention_time" : 72,
"sync_message_flush" : false,
"sync_replication" : "false",
"topic_other_configs" : [ {
"name" : "message.timestamp.type",
"value" : "LogAppendTime"
}, {
"name" : "max.message.bytes",
"value" : 10485760
} ],
"topic_desc" : ""
}
响应示例
状态码： 200
创建成功, v1版本返回id，v2版本返回name
{
"id" : "test01",
"name" : "test01"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建成功, v1版本返回id，v2版本返回name |
错误码
请参见错误码。
