Kafka实例创建Topic
功能介绍
该接口用于向Kafka实例创建Topic。
URI
POST /v2/{project_id}/instances/{instance_id}/topics
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: Topic名称。 约束限制: 长度为3-200,以字母开头且只支持大小写字母、中横线、下划线、点以及数字。 取值范围: 不涉及 默认取值: 不涉及。 |
| replication | 否 | Integer | 参数解释: 副本数,配置数据的可靠性。 约束限制: 副本数和代理数有关,如果有3个代理,最大副本数是3。 取值范围: 不涉及 默认取值: 不涉及。 |
| sync_message_flush | 否 | Boolean | 参数解释: 是否使用同步落盘,同步落盘会导致性能降低。 约束限制: 不涉及。 取值范围:
默认取值: false |
| partition | 否 | Integer | 参数解释: Topic分区数,设置消费的并发数。 约束限制: 不涉及。 取值范围: 1-200。 默认取值: 不涉及。 |
| sync_replication | 否 | Boolean | 参数解释: 是否开启同步复制。 约束限制: 不涉及。 取值范围:
默认取值: false。 |
| retention_time | 否 | Integer | 参数解释: 消息老化时间。 约束限制: 不涉及。 取值范围: 1-720 默认取值: 72 |
| topic_other_configs | 否 | Array of topic_other_configs objects | 参数解释: Topic配置 |
| topic_desc | 否 | String | 参数解释: Topic描述。 约束限制: 不涉及。 取值范围: 0-200个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: Topic名称。 取值范围: 不涉及 |
请求示例
创建一个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
创建成功,返回topic名称
{
"name" : "test01"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建成功,返回topic名称 |
错误码
请参见错误码。