更新时间:2025-12-24 GMT+08:00

修改Kafka实例Topic

功能介绍

修改Kafka实例Topic

URI

PUT /v2/{project_id}/instances/{instance_id}/topics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topics

Array of topics objects

参数解释

待修改的Topic列表。

约束限制

不涉及。

表3 topics

参数

是否必选

参数类型

描述

id

String

参数解释

Topic名称,不支持修改。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

retention_time

Integer

参数解释

老化时间,单位小时。

约束限制

不涉及。

取值范围

0-720。

默认取值

不涉及。

sync_replication

Boolean

参数解释

是否同步复制。

约束限制

不涉及。

取值范围

  • true:开启同步复制。

  • false:不开启同步复制。

默认取值

不涉及。

sync_message_flush

Boolean

参数解释

是否同步落盘。

约束限制

不涉及。

取值范围

  • true:开启同步落盘。

  • false:不开启同步落盘。

默认取值

不涉及。

new_partition_numbers

Integer

参数解释

分区数。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

new_partition_brokers

Array of integers

参数解释

增加分区时指定broker列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

topic_other_configs

Array of topic_other_configs objects

参数解释

Topic配置。

约束限制

不涉及。

topic_desc

String

参数解释

Topic描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 topic_other_configs

参数

是否必选

参数类型

描述

name

String

参数解释

配置名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

value

String

参数解释

配置值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:204

修改成功。

请求示例

修改Topic参数,topic-1284340884的老化时间修改为72小时,分区数修改为6,新增分区分布在broker-1和broker-2上,不同步复制,不同步落盘,消息时间类型为LogAppendTime,最大批处理大小10485760。

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics

{
  "topics" : [ {
    "id" : "test01",
    "retention_time" : 72,
    "sync_replication" : false,
    "sync_message_flush" : false,
    "new_partition_numbers" : 6,
    "new_partition_brokers" : [ 1, 2 ],
    "topic_other_configs" : [ {
      "name" : "message.timestamp.type",
      "value" : "LogAppendTime"
    }, {
      "name" : "max.message.bytes",
      "value" : 10485760
    } ],
    "topic_desc" : "This is a test topic"
  } ]
}

响应示例

状态码

状态码

描述

204

修改成功。

错误码

请参见错误码