修改实例信息

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

实例名称。

约束限制：

由英文字符开头，只能由英文字母、数字、中划线和下划线组成，名称长度为4到64位的字符串。

取值范围：

不涉及。

默认取值：

不涉及。

description

否

String

参数解释：

实例的描述信息。

约束限制：

长度不超过1024的字符串。

取值范围：

不涉及。

默认取值：

不涉及。

port

否

Integer

参数解释：

实例自定义端口。

约束限制：

只有创建Redis4.0及以上版本的实例才支持自定义端口。Memcached实例不支持。

创建Redis实例时，如果没发送该参数或该参数为空，表示实例使用默认端口6379。如果自定义端口，端口范围为1~65535的任意数字。

取值范围：

1~65535

默认取值：

6379

rename_commands

否

RenameCommandRuqest object

参数解释：

命令重命名列表。

maintain_begin

否

String

参数解释：

维护时间窗开始时间。

约束限制：

必须是UTC时间，格式为HH:mm:ss

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

• 开始时间必须为18:00:00、19:00:00等整点时间。

• 该参数不能单独为空，若该值为空，则结束时间也为空。

取值范围：

不涉及。

默认取值：

18:00:00。

maintain_end

否

String

参数解释：

维护时间窗结束时间。

约束限制：

必须是UTC时间，格式为HH:mm:ss

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

• 开始时间必须为18:00:00、19:00:00等整点时间。

• 该参数不能单独为空，若该值为空，则结束时间也为空。

取值范围：

不涉及。

默认取值：

19:00:00。

security_group_id

否

String

参数解释：

指定实例所属的安全组。

当engine为Redis且engine_version为4.0及以上版本实例时，该参数为可选。Redis4.0及以上版本实例不支持安全组控制访问(会设置为默认参数值securityGroupId)，只支持白名单控制。

获取方法如下：

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

• 方法2：通过虚拟私有云服务的查询安全组列表API接口查询。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_backup_policy

否

BackupPolicy object

参数解释：

备份策略，实例类型为主备和集群时支持。

command

否

String

参数解释：

可命令重命名的命令command。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

flushall

否

String

参数解释：

可命令重命名的命令flushall。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

flushdb

否

String

参数解释：

可命令重命名的命令flushdb。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

hgetall

否

String

参数解释：

可命令重命名的命令hgetall。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keys

否

String

参数解释：

可命令重命名的命令hgetall。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

backup_type

是

String

参数解释：

备份类型。

约束限制：

不涉及。

取值范围：

• auto：自动备份。

• manual：手动备份。

默认取值：

不涉及。

save_days

否

Integer

参数解释：

当backup_type设置为auto时，该参数为必填。

保留天数，单位：天，取值范围：1-7。由自动切换为手动时，保留自动备份策略信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

periodical_backup_plan

否

BackupPlanRequst object

参数解释：

备份计划。

约束限制：

当backup_type设置为auto时，该参数为必填。由自动切换为手动时，保留自动备份策略信息。

timezone_offset

否

String

参数解释：

备份的时区。该参数已废弃，没有实际作用。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

backup_at

是

Array of integers

参数解释：

每周的周几开始备份。由自动切换为手动时，保留自动备份策略信息。取值1-7，分别表示星期一到星期日。

约束限制：

不涉及。

period_type

是

String

参数解释：

备份周期类型，目前支持“weekly”。由自动切换为手动时，保留自动备份策略信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

begin_at

是

String

参数解释：

备份开始执行时间，该时间为UTC时间，例如“00:00-01:00”代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

204

修改缓存实例成功。

400

非法请求。

500

内部服务错误。