文档首页> 分布式消息服务RocketMQ版> API参考（吉隆坡区域）> API V2（推荐）> 生命周期管理> 修改实例信息
更新时间：2024-04-08 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报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。

security_group_id

否

String

安全组ID。

获取方法如下：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。

enable_acl

否

Boolean

ACL访问控制。

enable_publicip

否

Boolean

是否开启公网。

publicip_id

否

String

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

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

如果开启了公网访问功能（即enable_publicip为true），该字段为必选。

响应参数

无

请求示例

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

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

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

响应示例

无

状态码

状态码

描述

204

修改实例信息成功。

错误码

请参见错误码。

父主题： 生命周期管理