文档首页 > > API参考> API V2(推荐)> 生命周期管理>

修改实例信息

修改实例信息

分享
更新时间:2021/02/08 GMT+08:00

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

实例名称。

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

description

String

实例的描述信息。

长度不超过1024的字符串。

说明:

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

maintain_begin

String

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

  • 维护时间窗开始和结束时间必须为指定的时间段,可参考查询维护时间窗时间段

  • 开始时间必须为22:00:00、02:00:00、06:00:00、10:00:00、14:00:00和18:00:00。

  • 该参数不能单独为空,若该值为空,则结束时间也为空。系统分配一个默认开始时间02:00:00。

maintain_end

String

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

  • 维护时间窗开始和结束时间必须为指定的时间段,可参考查询维护时间窗时间段

  • 结束时间在开始时间基础上加四个小时,即当开始时间为22:00:00时,结束时间为02:00:00。

  • 该参数不能单独为空,若该值为空,则开始时间也为空。系统分配一个默认结束时间06:00:00。

security_group_id

String

安全组ID。

enable_publicip

Boolean

RabbitMQ实例是否开启公网访问功能。

  • true:开启

  • false:不开启

publicip_id

String

RabbitMQ实例绑定的弹性IP地址的id。

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

获取方法:

  • 方法1:登录弹性公网IP和带宽的控制台界面,在弹性公网IP的详情页面查的基本信息栏找ID。

  • 方法2:通过弹性公网IP的API接口查询,具体操作可参考查询公网IP ID

enterprise_project_id

String

企业项目。

响应参数

请求示例

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

    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

修改实例成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问