更新时间:2024-11-26 GMT+08:00

变更实例规格

功能介绍

用户可以为状态为“运行中”的DCS缓存实例进行规格变更。

URI

POST /v2/{project_id}/instances/{instance_id}/resize

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

实例ID。

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

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。

说明:目前不支持3.0 proxy集群的缩容。该参数支持数字类型的0.125,0.25,0.5。

bss_param

BssParamEntity object

按需计费无需填写。

reserved_ip

Array of strings

需要保留的节点IP。cluster集群缩容时需要填写,不填写时系统将随机删除多余的分片。

change_type

String

变更类型,Redis 4.0或者5.0实例进行副本数变更时必选。

  • createReplication: 添加副本

  • deleteReplication: 删除副本

  • addSharding: 添加分片

  • instanceType: 实例类型变更。

枚举值:

  • createReplication

  • deleteReplication

  • addSharding

  • instanceType

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

Boolean

是否立即变更。默认值为true。

  • true: 立即变更。

  • false: 可维护时间窗内进行变更。目前暂不支持选择变更时间,仅支持立即变更。

表3 BssParamEntity

参数

是否必选

参数类型

描述

is_auto_pay

String

该参数暂未启用。

响应参数

请求示例

变更实例规格,新的缓存实例规格是1GB。

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize

{
  "spec_code" : "redis.ha.xu1.tiny.r2.1",
  "new_capacity" : 1,
  "reserved_ip" : [ "192.168.0.125" ],
  "change_type" : "createReplication",
  "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ],
  "node_list" : [ "ff80808282eee5f90183120188ae093e" ],
  "execute_immediately" : true
}

响应示例

状态码

状态码

描述

204

缓存实例规格变更成功。

错误码

请参见错误码