修改实例信息_生命周期管理_API V2（推荐）_API参考（安卡拉区域）

功能介绍

修改缓存实例的信息，可修改信息包括实例名称、描述、端口号、备份策略、维护时间窗开始和结束时间以及安全组。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
instance_id	是	String	实例ID。
project_id	是	String	项目ID。获取方法请参见获取项目ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	实例名称。由英文字符开头，只能由英文字母、数字、中划线和下划线组成。创建单个实例时，名称长度为4到64位的字符串。批量创建实例时，名称长度为4到56位的字符串，且实例名称格式为“自定义名称-n”，其中n从000开始，依次递增。例如，批量创建两个实例，自定义名称为dcs_demo，则两个实例的名称为dcs_demo-000和dcs_demo-001。
description	否	String	实例的描述信息长度不超过1024的字符串。说明： \与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。最小长度：0 最大长度：1024
port	否	Integer	修改Redis实例的访问端口。端口范围为1~65535的任意数字。修改后，Redis实例的所有连接将会中断，业务需要重新连接Redis的新端口。只有支持修改端口号。最小值：1 最大值：65535
rename_commands	否	RenameCommandResp object	命令重命名列表。
maintain_begin	否	String	\|
maintain_end	否	String	维护时间窗结束时间，为UTC时间，格式为HH:mm:ss。维护时间窗开始和结束时间必须为指定的时间段，可参考查询维护时间窗时间段获取。结束时间在开始时间基础上加一个小时，即当开始时间为18:00:00时，结束时间为19:00:00。该参数不能单独为空，若该值为空，则开始时间也为空。
security_group_id	否	String	安全组ID。可从虚拟私有云服务的控制台界面，或者通过查询安全组列表的API接口查询得到。约束：只有Redis 3.0支持。
instance_backup_policy	否	BackupPolicy object	备份策略，实例类型为主备和集群时支持。

表3 RenameCommandResp
参数	是否必选	参数类型	描述
command	否	String	命令command
flushall	否	String	命令flushall
flushdb	否	String	命令flushdb
hgetall	否	String	命令hgetall
keys	否	String	命令keys

表4 BackupPolicy
参数	是否必选	参数类型	描述
backup_type	是	String	备份类型。 auto：自动备份 manual：手动备份
save_days	否	Integer	当backup_type设置为auto时，该参数为必填。保留天数，单位：天，取值范围：1-7。由自动切换为手动时，保留自动备份策略信息。
periodical_backup_plan	否	BackupPlan object	备份计划，当backup_type设置为auto时，该参数为必填。由自动切换为手动时，保留自动备份策略信息。

表5 BackupPlan
参数	是否必选	参数类型	描述
timezone_offset	否	String	备份的时区。该参数已废弃，没有实际作用。
backup_at	是	Array of integers	每周的周几开始备份，取值1-7，1代表周一，7代表周日。由自动切换为手动时，保留自动备份策略信息。
period_type	是	String	备份周期类型，目前支持“weekly”。由自动切换为手动时，保留自动备份策略信息。
begin_at	是	String	备份开始执行时间，该时间为UTC时间，例如“00:00-01:00”代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。

响应参数

无

请求示例

修改指定实例的信息，修改实例名称为dcs002，端口为6379，设置自动备份策略。

PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}

{
  "name" : "dcs002",
  "description" : "instance description",
  "port" : 6379,
  "maintain_begin" : "18:00:00",
  "maintain_end" : "19:00:00",
  "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162",
  "instance_backup_policy" : {
    "backup_type" : "auto",
    "save_days" : "1,",
    "periodical_backup_plan" : {
      "backup_at" : [ "1", "2", "3", "4", "6", "7" ],
      "period_type" : "weekly",
      "begin_at" : "00:00-01:00"
    }
  }
}

响应示例

无

状态码

状态码	描述
204	修改缓存实例成功。
400	非法请求。
500	内部服务错误。

错误码

请参见错误码。

修改实例信息

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

您对此文档页面的整体评价？