修改实例信息
功能介绍
修改实例的名称和描述信息。
URI
PUT /v2/{project_id}/instances/{instance_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方式请参见获取项目ID。 |
| instance_id | 是 | String | 实例ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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。 |
| enable_publicip | 否 | Boolean | RabbitMQ实例是否开启公网访问功能。
|
| publicip_id | 否 | String | RabbitMQ实例绑定的弹性IP地址的id。 如果开启了公网访问功能(即enable_publicip为true),该字段为必选。 获取方法:参考《弹性公网IP API参考》,调用“查询弹性公网IP列表”接口,从响应体中获取弹性公网IP的ID。 |
| enterprise_project_id | 否 | String | 企业项目。 |
| enable_acl | 否 | Boolean | ACL访问控制。 |
响应参数
状态码:204
修改实例成功。
无
请求示例
-
修改实例的名称和描述。
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id} { "name" : "rabbitmq-01", "description" : "instance description" } -
修改实例的名称、描述和维护时间窗。
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id} { "name" : "rabbitmq-01", "description" : "instance description", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00" } -
开启公网访问。
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id} { "enable_publicip" : true, "publicip_id" : "32685c2b-xxxx-xxxx-86c6-a1902359xxxx" }
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 204 | 修改实例成功。 |
错误码
请参见错误码。