更新时间:2023-08-16 GMT+08:00

修改实例信息

当前页面API为历史版本API,未来可能停止维护。请使用修改实例信息

功能介绍

修改实例的信息,包括实例名称、实例描述、实例维护时间窗、安全组等信息。

URI

PUT /v1.0/{project_id}/instances/{instance_id}

表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

instance_id

String

实例ID。

请求消息

请求参数

参数说明见表2

表2 参数说明

参数

类型

必选

说明

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。

retention_policy

String

容量阈值策略。 支持两种策略模式:

  • produce_reject: 生产受限
  • time_base: 自动删除

enterprise_project_id

String

企业项目。

请求示例

示例1 :

PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{  
    "name": "dms002",  
    "description": "instance description"  
} 

示例2

PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{ 
     "name": "dms002",   
     "description": "instance description", 
     "maintain_begin":"02:00:00", 
     "maintain_end":"06:00:00" 
}

响应消息

响应参数

无。

响应样例

无。

状态码

操作成功的状态码如表3所示,其他响应见状态码

表3 状态码

状态码

描述

204

修改实例成功。