更新时间:2026-04-03 GMT+08:00

修改实例信息

功能介绍

修改实例相关信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

实例名称。

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

实例的描述信息。

约束限制

长度不超过1024的字符串。

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

取值范围

不涉及。

默认取值

不涉及。

security_group_id

String

参数解释

安全组ID。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

enable_acl

Boolean

参数解释

是否开启ACL访问控制。

约束限制

不涉及。

取值范围

  • true:开启ACL访问控制。

  • false:不开启ACL访问控制。

默认取值

不涉及。

enable_publicip

Boolean

参数解释

是否开启公网。

约束限制

不涉及。

取值范围

  • true:开启公网。

  • false:不开启公网。

默认取值

不涉及。

publicip_id

String

参数解释

实例绑定的弹性IP地址的ID。

约束限制

以英文逗号隔开多个弹性IP地址的ID。

如果开启了公网访问功能(即enable_publicip为true),该字段为必选。

取值范围

不涉及。

默认取值

不涉及。

enterprise_project_id

String

参数解释

企业项目。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:204

修改实例信息成功。

请求示例

修改RocketMQ实例的名称和描述信息。

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

{
  "name" : "rocketmq001",
  "description" : "RocketMQ description"
}

响应示例

状态码

状态码

描述

204

修改实例信息成功。

错误码

请参见错误码