批量创建云数据库 Tair(兼容 Redis)经典版实例。
接口说明
请确保在使用该接口前,已充分了解云数据库 Tair(兼容 Redis)产品的收费方式和价格。
本接口仅支持创建经典版实例。 推荐您使用创建单个实例的 API 接口:
CreateInstance :创建 Redis 开源版实例、Tair 内存型经典版实例。
CreateTairInstance :创建 Tair 云原生版实例(含内存型、持久内存、磁盘型)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
kvstore:CreateInstances |
create |
*DBInstance
|
|
无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Instances |
string |
是 |
新实例的配置信息,格式为 JSON,详细说明请参见 Instances 参数补充说明。 |
[{ "RegionId": "cn-hangzhou", "izNo": "cn-hangzhou-b", "quantity": 1, "instanceType": "Redis", "instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default", "EngineVersion": "5.0", "ChargeType":"PrePaid", "Period":"1", "networkType": "VPC" , "vpcId": "vpc-2zex6u1nu32k3ux35oxxx", "vSwitchId": "vsw-2zesk464e647104kw3xxx" }] |
| Token |
string |
否 |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。 |
ETnLKlblzczshOTUbOCz**** |
| AutoPay |
boolean |
否 |
是否自动付费,取值:
说明
Instances 参数中,ChargeType 取值为 PrePaid 时,本参数才可用。 |
true |
| BusinessInfo |
string |
否 |
业务扩展信息。 |
000000000 |
| CouponNo |
string |
否 |
优惠码,默认值为: |
youhuiquan_promotion_option_id_for_blank |
| EngineVersion |
string |
否 |
实例兼容 Redis 的版本,取值:4.0、5.0。 说明
默认值为5.0。 枚举值:
|
5.0 |
| RebuildInstance |
boolean |
否 |
是否需要从回收站中重建恢复源实例,取值:
说明
Instances 参数中设置了 SrcDBInstanceId 参数时,本参数才可用。 |
false |
| AutoRenew |
string |
否 |
是否开启自动续费,取值:
说明
Instances 参数中,ChargeType 取值为 PrePaid 时,本参数才可用。 |
false |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-resourcegroupid1 |
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 为社区版(经典版)标准架构双副本 1 GB 实例,详细信息请参见规格查询导航。 说明 本参数和Capacity两者中必须传入一项。 |
| Capacity | Long | 否 | 16384 | 实例的存储容量,单位为 MB,详细信息请参见规格查询导航。 说明 本参数和InstanceClass两者中必须传入一项。 |
| EngineVersion | String | 否 | 5.0 | 实例兼容 Redis 的版本,取值:
|
| ChargeType | String | 否 | PrePaid | 付费类型,取值:
|
| Period | Long | 否 | 12 | 付费周期,单位为月,取值:1~9、12、24、36、60。 说明 当ChargeType参数取值为PrePaid时,本参数才可用且必须传入。 |
| AutoRenew | String | 否 | true | 是否开启自动续费,取值:
|
| InstanceName | String | 否 | apitest | 实例的名称,需满足下述要求:
|
| Password | String | 否 | Pass!123456 | 实例的密码,需满足下述要求:
|
| NetworkType | String | 否 | VPC | 网络类型,取值:VPC(当前仅支持创建 VPC 网络实例):专有网络 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 | 是否需要从回收站中重建恢复源实例,取值:
|
Instances 参数请求示例
[{
"RegionId": "cn-hangzhou",
"izNo": "cn-hangzhou-b",
"quantity": 1,
"instanceType": "Redis",
"instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default",
"EngineVersion": "5.0",
"ChargeType": "PrePaid",
"Period":"1",
"networkType": "VPC" ,
"vpcId": "vpc-2zex6u1nu32k3ux35xxxx",
"vSwitchId": "vsw-2zesk464e647104kwxxxx"
}]
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| OrderId |
string |
订单 ID。 |
20905403119**** |
| RequestId |
string |
请求 ID。 |
561AFBF1-BE20-44DB-9BD1-6988B53E**** |
| InstanceIds |
object |
||
| InstanceId |
array |
本次创建的实例 ID 的列表。 |
|
|
string |
实例 ID。 |
r-bp16e70a4338**** |
示例
正常返回示例
JSON格式
{
"OrderId": "20905403119****",
"RequestId": "561AFBF1-BE20-44DB-9BD1-6988B53E****",
"InstanceIds": {
"InstanceId": [
"r-bp16e70a4338****"
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Zone.Closed | Specified zone is closed. | 指定的可用区已关闭 |
| 400 | MissingParameter | Period is mandatory for this action. | |
| 400 | InvalidToken.Malformed | The Specified parameter "Token" is not valid. | |
| 400 | InvalidInstanceName.Malformed | The Specified parameter "InstanceName" is not valid. | |
| 400 | InvalidPassword.Malformed | The Specified parameter "Password" is not valid. | 指定的Password参数不符合规范要求 |
| 400 | InvalidInstances.Malformed | The Specified parameter "Instances" is not valid. | 传入的Instances参数是无效的。 |
| 400 | InsufficientBalance | Your account does not have enough balance. | |
| 400 | QuotaExceed.AfterpayInstance | Living afterpay instances quota exceeded. | |
| 400 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | |
| 400 | ResourceNotAvailable | Resource you requested is not available for finance user. | |
| 400 | PaymentMethodNotFound | No payment method has been registered on the account. | |
| 400 | IdempotentParameterMismatch | Request uses a client token in a previous request but is not identical to that request. | 幂等性校验不过。 |
| 400 | QuotaNotEnough | Quota not enough in this zone. | |
| 400 | QuotaExceed | Living afterpay instances quota exceed. | |
| 400 | VpcServiceError | Invoke vpc service failed. | |
| 400 | IzNotSupportVpcError | Specify iz not support vpc. | |
| 400 | InvalidVpcIdRegion.NotSupported | The Specified vpcId or vSwitchId not supported. | |
| 400 | ResourceGroupNotExist | The Specified ResourceGroupId does not exist. | |
| 403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | |
| 404 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | 所指定的存储规格不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。