变更实例规格
功能介绍
用户可以为状态为“运行中”的DCS缓存实例进行规格变更。
URI
POST /v2/{project_id}/instances/{instance_id}/resize
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例ID。可通过DCS控制台进入实例详情界面查看。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
spec_code |
是 |
String |
参数解释: 变更后的产品规格编码。具体查询方法如下:
约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
new_capacity |
是 |
Integer |
参数解释: 新的缓存实例规格,单位:GB。 约束限制: Redis4.0及以上版本:单机和主备类型实例取值:0.125、0.25、0.5、1、2、4、8、16、32、64。集群实例规格支持4、8、16、24、32、48、64、96、128、192、256、384、512、768、1024。 Memcached:单机和主备类型实例取值:2、4、8、16、32、64。 说明:目前不支持3.0 proxy集群的缩容。该参数支持数字类型的0.125,0.25,0.5。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
bss_param |
否 |
BssParamEntity object |
参数解释: 按需计费无需填写。 |
|
reserved_ip |
否 |
Array of strings |
参数解释: 需要保留的节点IP。cluster集群缩容时需要填写,不填写时系统将随机删除多余的分片。 |
|
change_type |
否 |
String |
参数解释: 变更类型,Redis实例进行副本数变更时必选。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
available_zones |
否 |
Array of strings |
参数解释: Redis实例进行添加副本时必选,指定每个副本所在的可用区Code,使用前需要先确认该可用区是否有足够资源。集群实例删除副本时必选。 具体查询方法,请参考查询可用区信息。 |
|
node_list |
否 |
Array of strings |
参数解释: Redis主备或读写分离实例进行删除副本时必选,指定需要删除的节点ID,目前仅支持一次删除一个副本。 节点ID查询方法,请参考查询分片信息。 |
|
execute_immediately |
否 |
Boolean |
参数解释: 是否立即变更。 约束限制: 不涉及。 取值范围:
默认取值: true。 |
|
enable_ipv6 |
否 |
Boolean |
参数解释: 是否开启IPV6。 约束限制: 不涉及。 取值范围: true:开启IPv6。 false:关闭IPv6。 默认取值: false。 |
|
spec_param |
否 |
SpecParam object |
参数解释: 线性规格定义参数。 约束限制: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_auto_pay |
否 |
String |
参数解释: 该参数暂未启用。 约束限制: 不涉及。 取值范围:
默认取值: false |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
sharding_count |
否 |
Integer |
参数解释: 实例分片数。 约束限制: 不涉及。 取值范围: 1-128。 默认取值: 不涉及。 |
|
replica_count |
否 |
Integer |
参数解释: 实例副本数。 约束限制: 不涉及。 取值范围: 1-10 默认取值: 不涉及。 |
|
cache_mode |
否 |
String |
参数解释: 缓存实例类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:204
缓存实例规格变更成功。
无
请求示例
-
变更实例规格,新的缓存实例规格为3副本1GB的主备实例。
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize { "spec_code" : "redis.ha.xu1.large.r3.1", "new_capacity" : 1, "change_type" : "createReplication", "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ], "execute_immediately" : true } -
变更实例规格,新的缓存实例规格为2副本8GB的cluster集群实例。
{ "spec_code" : "redis.cluster.xu1.large.r2.8", "new_capacity" : 8, "reserved_ip" : [ "192.168.0.125" ], "change_type" : "deleteReplication", "execute_immediately" : true }
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
204 |
缓存实例规格变更成功。 |
错误码
请参见错误码。