文档

CreateInstances - 批量创建Redis实例

更新时间:

批量创建Redis实例。

接口说明

请确保在使用该接口前,已充分了解云数据库 Redis 产品的收费方式和价格

说明 该 API 对应的控制台操作方法和选型建议,请参见创建 Redis 实例

本接口仅支持创建 Redis 实例、Tair(Redis 企业版)内存型经典版实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:CreateInstancesWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/*
  • kvstore:InstanceClass
  • kvstore:InstanceType
  • kvstore:Appendonly

请求参数

名称类型必填描述示例值
Instancesstring

新实例的配置信息,格式为 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" }]
Tokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。

ETnLKlblzczshOTUbOCz****
AutoPayboolean

是否自动付费,取值:

  • true:自动付费,默认值。
  • false:手动付费。您需要在控制台的顶部菜单栏,单击费用 > 续费管理,然后单击左侧导航栏的订单管理 > 我的订单,找到目标订单进行支付。
说明 Instances 参数中,ChargeType 取值为 PrePaid 时,本参数才可用。
true
BusinessInfostring

业务扩展信息。

000000000
CouponNostring

优惠码,默认值为:youhuiquan_promotion_option_id_for_blank

youhuiquan_promotion_option_id_for_blank
EngineVersionstring

Redis 实例的大版本,取值:4.05.0

说明 默认值为5.0
5.0
RebuildInstanceboolean

是否需要从回收站中重建恢复源实例,取值:

  • true:需要。
  • false:不需要,默认值。
说明 Instances 参数中设置了 SrcDBInstanceId 参数时,本参数才可用。
false
AutoRenewstring

是否开启自动续费,取值:

  • true:开启。
  • false:不开启,默认值。
说明 Instances 参数中,ChargeType 取值为 PrePaid 时,本参数才可用。
false
ResourceGroupIdstring

资源组 ID。

rg-resourcegroupid1

Instances 参数补充说明

名称类型是否必选示例值描述
RegionIdStringcn-hangzhou地域 ID,可调用DescribeRegions查询,使用此参数指定要创建实例的地域。
IzNoStringcn-hangzhou-b主可用区 ID,可调用DescribeRegions查询,使用此参数指定要创建实例的可用区。
QuantityInteger1要创建的实例数量,取值范围:1~300,默认值为1
InstanceTypeStringRedis实例类型,取值:
  • Redis(默认):Redis 实例。
  • Memcache:Memcache 实例。
InstanceClassStringredis.master.small.default实例的规格,例如 redis.master.small.default 为社区版(经典版)标准架构双副本 1 GB 实例,详细信息请参见规格查询导航
说明 本参数和Capacity两者中必须传入一项。
CapacityLong16384实例的存储容量,单位为 MB,详细信息请参见规格查询导航
说明 本参数和InstanceClass两者中必须传入一项。
EngineVersionString5.0Redis 实例的大版本,取值:
  • 5.0(默认)
  • 4.0
ChargeTypeStringPrePaid付费类型,取值:
  • PrePaid:包年包月(预付费)。
  • PostPaid(默认):按量付费(后付费)。
PeriodLong12付费周期,单位为月,取值:1~912243660
说明ChargeType参数取值为PrePaid时,本参数才可用且必须传入。
AutoRenewStringtrue是否开启自动续费,取值:
  • true:开启。
  • false(默认):不开启。
说明ChargeType参数取值为PrePaid时,本参数才可用。
InstanceNameStringapitest实例的名称,需满足下述要求:
  • 以大小写字母或中文开头,长度为 2~80 个字符。
  • 不支持空格和特殊字符:@/:=”<>{[]}
PasswordStringPass!123456实例的密码,需满足下述要求:
  • 长度为 8~32 位。
  • 需包含大写字母、小写字母、特殊字符和数字中的至少三种。
  • 支持的特殊字符为:!@#$%^&*()_+-=
NetworkTypeStringVPC网络类型,取值:VPC(默认):专有网络 VPC。
VpcIdStringvpc-bp1nme44gek34slfc****专有网络 ID,可调用专有网络 VPC 的DescribeVpcs获取。
VSwitchIdStringvsw-bp1e7clcw529l773d****该专有网络下的虚拟交换机 ID,可调用专有网络 VPC 的DescribeVpcs获取。
NodeTypeStringMASTER_SLAVE节点类型,取值:
  • STAND_ALONE:单副本。
  • MASTER_SLAVE(默认):高可用(双副本)。
SrcDBInstanceIdStringr-bp1zxszhcgatnx****源实例 ID,可调用DescribeInstances获取。
说明 当您需要基于该实例的备份数据创建新实例时,您才需要传入本参数。
BackupIdString111111111备份集 ID,可通过调用DescribeBackups查询。
说明 如需基于某个实例的备份数据创建新实例,在传入SrcDBInstanceId参数指定了源实例后,您还需要在本参数中指定源实例的备份集 ID,系统将基于该备份集的数据创建新的实例。
RebuildInstanceStringfalse是否需要从回收站中重建恢复源实例,取值:
  • true:需要。
  • false(默认):不需要。
说明 如果传入了本参数,则必须传入SrcDBInstanceId参数。

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"
}]

返回参数

名称类型描述示例值
object
OrderIdstring

订单 ID。

20905403119****
RequestIdstring

请求 ID。

561AFBF1-BE20-44DB-9BD1-6988B53E****
InstanceIdsarray

本次创建的实例 ID 的列表。

string

实例 ID。

r-bp16e70a4338****

示例

正常返回示例

JSON格式

{
  "OrderId": "20905403119****",
  "RequestId": "561AFBF1-BE20-44DB-9BD1-6988B53E****",
  "InstanceIds": {
    "InstanceId": [
      "r-bp16e70a4338****"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Zone.ClosedSpecified zone is closed.-
400MissingParameterPeriod is mandatory for this action.-
400InvalidToken.MalformedThe Specified parameter "Token" is not valid.Token验证失败
400InvalidInstanceName.MalformedThe Specified parameter "InstanceName" is not valid.InstanceName验证失败
400InvalidPassword.MalformedThe Specified parameter "Password" is not valid.密码验证无效
400InvalidInstances.MalformedThe Specified parameter "Instances" is not valid.Instances验证失败
400InsufficientBalanceYour account does not have enough balance.账户余额不足,请先充值再操作。
400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.超过了支付实例配额。
400InvalidCapacity.NotFoundThe Capacity provided does not exist in our records.Capacity 容量非法。
400ResourceNotAvailableResource you requested is not available for finance user.您所请求的资源对财务用户来说是不可用的。
400PaymentMethodNotFoundNo payment method has been registered on the account.帐户上没有登记付款方法。
400IdempotentParameterMismatchRequest uses a client token in a previous request but is not identical to that request.幂等性校验不过
400QuotaNotEnoughQuota not enough in this zone.这个区域的配额是不够的。
400QuotaExceedLiving afterpay instances quota exceed.超过了支付实例配额。
400VpcServiceErrorInvoke vpc service failed.-
400IzNotSupportVpcErrorSpecify iz not support vpc.指定 iz不支持Vpc。
400InvalidVpcIdRegion.NotSupportedThe Specified vpcId or vSwitchId not supported.-
400ResourceGroupNotExistThe Specified ResourceGroupId does not exist. -
403RealNameAuthenticationErrorYour account has not passed the real-name authentication yet.您的帐户还没有通过实名认证。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-02-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
  • 本页导读 (1)
文档反馈