文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 生命周期管理/ 修改实例配置
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改实例配置

功能介绍

修改实例配置。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

kafka_configs

否

Array of ModifyInstanceConfig objects

Kafka待修改配置列表。
表3 ModifyInstanceConfig

参数

是否必选

参数类型

描述

name

否

String

修改的配置名称。

value

否

String

配置的修改值。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

job_id

String

配置修改任务ID。

dynamic_config

Integer

本次修改动态配置参数个数。

static_config

Integer

本次修改静态配置参数个数。

请求示例

修改实例的连接空闲超时和日志删除的时间阈值。

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

{
  "kafka_configs" : [ {
    "name" : "connections.max.idle.ms",
    "value" : "500000"
  }, {
    "name" : "log.retention.hours",
    "value" : "66"
  } ]
}

响应示例

状态码：200

修改实例配置成功。

{
  "job_id" : "8abfa7b38ba79a20018ba9afc550576a",
  "dynamic_config" : 0,
  "static_config" : 2
}

状态码

状态码

描述

200

修改实例配置成功。

错误码

请参见错误码。

父主题： 生命周期管理