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

修改实例信息

功能介绍

修改实例信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

实例名称。

由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。

description

否

String

实例的描述信息。

长度不超过1024的字符串。

说明：
\与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。

maintain_begin

否

String

维护时间窗开始时间，格式为HH:mm:ss。

maintain_end

否

String

维护时间窗结束时间，格式为HH:mm:ss。

security_group_id

否

String

安全组ID。

获取方法如下：参考《虚拟私有云 API参考》，调用“查询安全组列表”接口，从响应体中获取安全组ID。

retention_policy

否

String

容量阈值策略。

支持两种策略模式：

  • produce_reject: 生产受限

  • time_base: 自动删除

enterprise_project_id

否

String

企业项目。

响应参数

状态码：204

修改实例信息成功

无

请求示例

  • 修改实例的名称和描述。

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

{
  "name" : "kafka001",
  "description" : "kafka description"
}

  • 修改实例的名称、描述和维护时间窗。

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

{
  "name" : "dms002",
  "description" : "instance description",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00"
}

  • 修改容量阈值策略。

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

{
  "retention_policy" : "time_base"
}

响应示例

无

状态码

状态码

描述

204

修改实例信息成功

错误码

请参见错误码。

父主题： 生命周期管理