本节介绍分布式缓存Redis产品订购、扩缩容、增减分片数、增减副本数、变配以及对应询价接口API参数,包括版本类型、实例类型、版本号、主机类型、分片规格、分片数、规格、副本数、磁盘类型等。
具体参数范围可能因为不同资源池配置上线的产品有所差异,可通过 资源池可创建规格 接口查询,具体可参照下表 API参数对照表。
资源池、可用区、虚拟私有云ID、所在子网ID、安全组ID、实例名称、实例密码参数为产品订购必填参数,本节不作详细说明。
基础版API参数
| 参数说明 | 参数取值 | 标准版 | Cluster集群 | Proxy集群 | 读写分离 |
|---|---|---|---|---|---|
| 版本类型 | version | BASIC | BASIC | BASIC | BASIC |
| 实例类型 | edition | StandardDual | DirectCluster | ClusterOriginalProxy | OriginalMultipleReadLvs |
| 版本号 | engineVersion |
|
|
|
|
| 主机类型 | hostType | X86计算:
ARM计算:
| X86计算:
ARM计算:
| X86计算:
ARM计算:
| X86计算:
ARM计算:
|
| 分片规格 | shardMemSize |
|
|
|
|
| 分片数 | shardCount | 不填 | 3~256 | 3~256 | 不填 |
| 规格 | capacity | 不填 | 不填 | 不填 | 不填 |
| 副本数 | copiesCount | 1~10(默认值:2) | 1~10(默认值:2) | 1~10(默认值:2) | 2~10(默认值:2) |
| 磁盘类型 | dataDiskType |
|
|
|
|
增强版API参数
| 参数说明 | 参数取值 | 标准版 | Cluster集群 | Proxy集群 | 读写分离 |
|---|---|---|---|---|---|
| 版本类型 | version | PLUS | PLUS | PLUS | PLUS |
| 实例类型 | edition | StandardDual | DirectCluster | ClusterOriginalProxy | OriginalMultipleReadLvs |
| 版本号 | engineVersion |
|
|
|
|
| 主机类型 | hostType | X86计算:
ARM计算:
| X86计算:
ARM计算:
| X86计算:
ARM计算:
说明:无默认值,参数必填。 | X86计算:
ARM计算:
说明:无默认值,参数必填。 |
| 分片规格 | shardMemSize |
|
|
|
|
| 分片数 | shardCount | 不填 | 3~256 | 3~256 | 不填 |
| 规格 | capacity | 不填 | 不填 | 不填 | 不填 |
| 副本数 | copiesCount | 1~10(默认值:2) | 1~10(默认值:2) | 1~10(默认值:2) | 2~10(默认值:2) |
| 磁盘类型 | dataDiskType |
|
|
|
|
API参数对照表
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| version | 否 | String | 版本类型,可通过 资源池可创建规格 接口使用表SeriesInfo中的version值。可选值:
| BASIC |
| edition | 是 | String | 实例类型,可通过 资源池可创建规格 接口使用表SeriesInfo中的seriesCode值。 | DirectCluster |
| engineVersion | 是 | String | 版本号,可通过 资源池可创建规格 接口使用表SeriesInfo中的engineTypeItems(引擎版本可选值)。 | 6.0 |
| hostType | 否 | String | 主机类型,可通过 资源池可创建规格 接口使用表resItems中resType==ecs的items(主机类型可选值) 。除增强版 Proxy集群和读写分离外,默认值为S:通用型。 | S |
| shardMemSize | 否 | String | 分片规格,可通过 资源池可创建规格 接口使用表SeriesInfo中shardMemSizeItems(单分片规格可选值),若shardMemSizeItems为空则无需填写。 | 1 |
| memUnit | 否 | String | 内存规格单位。
| G |
| shardCount | 否 | Integer | 分片数。
| 3 |
| capacity | 否 | String | 实例的存储容量,单位为 GB,可通过 资源池可创建规格 接口使用表SeriesInfo中memSizeItems(内存可选值)。 | 3 |
| copiesCount | 否 | Integer | 副本数,取值范围2~10 。
当 edition 取其他值时无需填写。 | 2 |
| dataDiskType | 否 | String | 磁盘类型,可通过 资源池可创建规格 接口使用表resItems中resType==ebs的items(磁盘类型可选值)。基础版和增强版默认值为SSD:超高IO。
| SSD |
请求参数示例
创建一个按需计费的Redis 基础标准版实例,内核版本号是5.0,缓存容量是4GB。
POST https://dcs2-global.ctapi.ctyun.cn/v2/lifeCycleServant/createInstance
{
"chargeType":"PostPaid",
"version": "BASIC",
"edition":"StandardDual",
"shardMemSize": 4,
"copiesCount": 2,
"memUnit": "G",
"engineVersion":"5.0",
"zoneName":"cn-xinan1-1A",
"secondaryZoneName":"cn-xinan1-2A",
"instanceName":"DCS2-StandardDual-APITest-1",
"password":"********",
"vpcId":"vpc-uf9gof2qa0",
"subnetId":"subnet-6do1ll389s",
"secgroups":"sg-j9ryoyupxr",
"cacheServerPort": 6379
}创建一个包周期计费1个月的Redis 基础Cluster集群版单副本3分片实例,内核版本号是6.0,缓存容量是6GB。
POST https://dcs2-global.ctapi.ctyun.cn/v2/lifeCycleServant/createInstance
{
"chargeType":"PrePaid",
"period": 1,
"autoPay": true,
"version": "BASIC",
"edition":"DirectCluster",
"shardMemSize": 2,
"shardCount": 3,
"copiesCount": 1,
"memUnit": "G",
"engineVersion":"6.0",
"zoneName":"cn-xinan1-1A",
"instanceName":"DCS2-DirectCluster-APITest-2",
"password":"********",
"vpcId":"vpc-uf9gof2qa0",
"subnetId":"subnet-6do1ll389s",
"secgroups":"sg-j9ryoyupxr",
"cacheServerPort": 6379
}创建一个包周期计费2个月,到期自动续订3个月的Redis 增强Proxy集群版3副本3分片实例,内核版本号是6.0,缓存容量是24GB。
POST https://dcs2-global.ctapi.ctyun.cn/v2/lifeCycleServant/createInstance
{
"chargeType":"PrePaid",
"period": 2,
"autoRenew": true,
"autoRenewPeriod": 3,
"autoPay": true,
"version": "PLUS",
"edition":"ClusterOriginalProxy",
"shardMemSize": 8,
"shardCount": 3,
"copiesCount": 3,
"memUnit": "G",
"engineVersion":"6.0",
"zoneName":"cn-xinan1-1A",
"secondaryZoneName":"cn-xinan1-2A",
"instanceName":"DCS2-ClusterOriginalProxy-APITest-3",
"password":"********",
"vpcId":"vpc-uf9gof2qa0",
"subnetId":"subnet-6do1ll389s",
"secgroups":"sg-j9ryoyupxr",
"cacheServerPort": 6379
}创建一个按需计费的Redis 基础读写分离3副本实例,内核版本号是7.0,缓存容量是8GB。
POST https://dcs2-global.ctapi.ctyun.cn/v2/lifeCycleServant/createInstance
{
"chargeType":"PostPaid",
"version": "BASIC",
"edition":"OriginalMultipleReadLvs",
"shardMemSize": 8,
"copiesCount": 3,
"memUnit": "G",
"engineVersion":"7.0",
"zoneName":"cn-xinan1-1A",
"secondaryZoneName":"cn-xinan1-2A",
"instanceName":"DCS2-OriginalMultipleReadLvs-APITest-4",
"password":"********",
"vpcId":"vpc-uf9gof2qa0",
"subnetId":"subnet-6do1ll389s",
"secgroups":"sg-j9ryoyupxr",
"cacheServerPort": 6379
}