变更实例规格
功能介绍
用户可以为状态为“运行中”的DCS缓存实例进行规格变更
接口约束
目前不支持3.0 proxy集群的缩容
调试
您可以在API Explorer中调试该接口,并获取该接口关联的CLI示例: hcloud DCS ResizeInstance。
URI
POST /v2/{project_id}/instances/{instance_id}/resize
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
实例ID。 |
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
spec_code |
是 |
String |
变更后的产品规格编码。具体查询方法如下: |
new_capacity |
是 |
Integer |
新的缓存实例规格,单位:GB。 取值包括:4,8,16,32,64 取值必须是当前产品支持的实例规格,请以实际为准。 |
bss_param |
否 |
BssParamEntity object |
按需计费无需填写,表示包周期计费模式的相关参数,包周期实例变更规格时需要填写。 |
reserved_ip |
否 |
Array of strings |
需要保留的节点ip。cluster集群缩容时需要填写,不填写时系统将随机删除多余的分片 |
change_type |
否 |
String |
变更类型,Redis 4.0或者5.0主备实例进行副本数变更时必选。
枚举值:
|
available_zones |
否 |
Array of strings |
Redis 4.0或者5.0主备实例进行添加副本时必选,指定每个副本所在的可用区Code,使用前需要先确认该可用区资源是否售罄。 具体查询方法,请参考查询可用区信息 |
node_list |
否 |
Array of strings |
Redis 4.0或者5.0主备实例进行删除副本时必选,指定需要删除的节点ID,目前仅支持一次删除一个副本。 节点ID查询方法,请参考查询分片信息 |
execute_immediately |
否 |
Object |
是否立即变更。默认值为true。
枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
is_auto_pay |
否 |
String |
功能说明:下单订购后,是否自动从客户的账户中支付;默认是“不自动支付” 。 取值范围:
约束: 自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。 如果没有设置成自动支付,即设置为false时,在变更规格之后,用户必须在“费用中心 > 我的订单”,完成订单支付,否则订单一直在支付中,实例没有变更成功。 枚举值:
|
响应参数
无
请求示例
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize
响应示例
无
状态码
状态码 |
描述 |
---|---|
204 |
缓存实例规格变更成功 |
错误码
请参见错误码。
