文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 主题管理/ 批量修改Kafka实例Topic - BatchUpdateInstanceTopics
更新时间：2025-11-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量修改Kafka实例Topic - BatchUpdateInstanceTopics

功能介绍

批量修改Kafka实例Topic。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/instances/{instance_id}/topics/batch-update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例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

参数解释：

配置值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

job_id

String

批量修改Topic参数的任务ID

请求示例

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

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

{
  "topics" : [ {
    "id" : "topic-1284340884",
    "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"
  } ]
}

响应示例

状态码：200

批量修改Topic参数成功。

{
  "job_id" : "ff8080828bdc0f64018bdcadfd8f00d8"
}

状态码

状态码

描述

200

批量修改Topic参数成功。

错误码

请参见错误码。

父主题： 主题管理

相关文档