在调用CreateInstances接口批量创建Redis实例时,您需要传入Instances参数来指定新实例的配置信息,本文为您介绍该参数的详细定义和请求示例。
相关接口
Instances参数说明
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 是 | cn-hangzhou | 地域ID,可调用DescribeRegions查询,使用此参数指定要创建实例的地域。 |
IzNo | String | 是 | cn-hangzhou-b | 主可用区ID,可调用DescribeRegions查询,使用此参数指定要创建实例的可用区。 |
Quantity | Integer | 否 | 1 | 要创建的实例数量,取值范围:1~300,默认值为1。 |
InstanceType | String | 否 | Redis | 实例类型,取值:
|
InstanceClass | String | 否 | redis.master.small.default | 实例的规格,例如redis.master.small.default为社区版(本地盘)标准版双副本1GB主从版实例,详细信息请参见规格查询导航。
说明 本参数和Capacity两者中必须传入一项。
|
Capacity | Long | 否 | 16384 | 实例的存储容量,单位为MB,详细信息请参见规格查询导航。
说明 本参数和InstanceClass两者中必须传入一项。
|
EngineVersion | String | 否 | 5.0 | Redis实例的大版本,取值:4.0、5.0,默认值为5.0。 |
ChargeType | String | 否 | PrePaid | 付费类型,取值:
|
Period | Long | 否 | 12 | 付费周期,单位为月,取值:1~9、12、24、36、60。
说明 当ChargeType参数取值为PrePaid时,本参数才可用且必须传入。
|
AutoRenew | String | 否 | true | 是否开启自动续费,取值:
说明 当ChargeType参数取值为PrePaid时,本参数才可用。
|
InstanceName | String | 否 | apitest | 实例的名称,需满足下述要求:
|
Password | String | 否 | Pass!123456 | 实例的密码,需满足下述要求:
|
NetworkType | String | 否 | VPC | 网络类型,取值:
|
VpcId | String | 否 | vpc-bp1nme44gek34slfc**** | 专有网络ID,可调用专有网络VPC的DescribeVpcs获取。 |
VSwitchId | String | 否 | vsw-bp1e7clcw529l773d**** | 该专有网络下的虚拟交换机ID,可调用专有网络VPC的DescribeVpcs获取。 |
NodeType | String | 否 | MASTER_SLAVE | 节点类型,取值:
|
SrcDBInstanceId | String | 否 | r-bp1zxszhcgatnx**** | 源实例ID,可调用DescribeInstances获取。
说明 当您需要基于该实例的备份数据创建新实例时,您才需要传入本参数。
|
BackupId | String | 否 | 111111111 | 备份集ID,可通过调用DescribeBackups查询。
说明 如需基于某个实例的备份数据创建新实例,在传入SrcDBInstanceId参数指定了源实例后,您还需要在本参数中指定源实例的备份集ID,系统将基于该备份集的数据创建新的实例。
|
RebuildInstance | String | 否 | false | 是否需要从回收站中重建恢复源实例,取值:
说明 如果传入了本参数,则必须传入SrcDBInstanceId参数。
|
Instances参数请求示例
[{
"RegionId": "cn-hangzhou",
"izNo": "cn-hangzhou-b",
"quantity": 2,
"instanceType": "Redis",
"instanceClass": "redis.master.small.default",
"EngineVersion": "5.0",
"ChargeType": "PostPaid"
}]