调用CreateTairInstance创建Redis企业版持久内存型或容量存储型实例。

选型参考资料,请参见阿里云Redis产品选型必读

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

说明

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTairInstance

系统规定参数,取值:CreateTairInstance

InstanceClass String tair.scm.standard.4m.32d

实例规格,更多信息,请参见:

InstanceType String tair_scm

实例类型,取值:

  • tair_scm:持久内存型。
  • tair_essd:容量存储型。
RegionId String cn-hangzhou

地域ID,可调用DescribeRegions查询,使用此参数指定要创建实例的地域。

VpcId String vpc-bp1nme44gek34slfc****

专有网络ID,可调用专有网络VPC的DescribeVpcs获取。

VSwitchId String vsw-bp1e7clcw529l773d****

该专有网络下的虚拟交换机ID,可调用专有网络VPC的DescribeVpcs获取。

ZoneId String cn-hangzhou-e

主可用区ID,可调用DescribeRegions查询,使用此参数指定要创建实例的可用区。

说明 如需实现同城双中心主备架构,即主备节点分别部署在指定的主可用区和备可用区,您可以传入 SecondaryZoneId参数指定备可用区。此时,本参数不可传入多可用区对应的ID。
InstanceName String apitest

实例名称,需满足下述要求:

  • 长度为2~128个字符。
  • 以大小写英文字母或中文开头,不支持空格和特殊字符:@/:=”<>{[]}
Password String Pass!123456

实例密码,需满足下述要求:

  • 长度为8~32位。
  • 需包含大写字母、小写字母、特殊字符和数字中的至少三种,支持的特殊字符为!@#$%^&*()_+-=
ChargeType String PrePaid

付费类型,取值固定为PrePaid(预付费,即包年包月)。

Period Integer 1

付费周期,单位为月,取值:1~912243660

说明ChargeType取值为 PrePaid时,本参数必须传入。
BusinessInfo String 000000000

活动ID、业务信息。

CouponNo String youhuiquan_promotion_option_id_for_blank

优惠码。

SrcDBInstanceId String r-bp1zxszhcgatnx****

源实例ID。

说明 如需基于某个实例的备份集创建新实例,请先在此参数中指定源实例ID,然后通过 BackupId参数指定需要使用的备份集。
BackupId String 11111111

源实例的备份集ID,可调用DescribeBackups获取。

说明 如需基于某个实例的备份数据创建新实例,在通过 SrcDBInstanceId指定源实例ID后,您还需传入本参数指定源实例的备份集ID,系统将使用该备份集中保存的数据创建新实例。
PrivateIpAddress String 172.16.88.***

指定实例的内网IP地址。

说明 该地址需在实例所属交换机的网段内,您可以调用专有网络VPC的 DescribeVSwitches获取网段信息。
AutoUseCoupon String true

是否使用代金券,取值:

  • true:使用代金券。
  • false:默认值,不使用代金券。
AutoRenew String true

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

  • true:开启。
  • false:默认值,不开启。
AutoRenewPeriod String 3

自动续费周期,单位为月,取值:123612

说明AutoRenew取值为 true时,本参数必须传入。
AutoPay Boolean true

自动支付,取值固定为true

ClientToken String ETnLKlblzczshOTUbOCz****

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

StorageType String essd_pl1

存储类型,取值固定为essd_pl1

说明InstanceType取值为 tair_essd时,本参数才可用。
Storage Integer 60

云盘的存储空间,不同的规格取值范围有所区别,详情请参见容量存储型规格

说明InstanceType取值为 tair_essd时,本参数才可用且必须传入。
ShardType String MASTER_SLAVE

节点类型,取值固定为MASTER_SLAVE,即数据节点采用主从架构,可保障可用性。

ShardCount Integer 1

实例中的数据节点个数,取值:

  • 1:默认值,即表示创建的实例为标准架构,仅拥有1个数据节点。
  • 2~32:传入该范围的值,即表示创建的实例为集群架构,拥有指定数量的数据节点。
说明InstanceType取值为 tair_scm时,本参数才可以传入 2~ 32,即只有持久内存型支持集群架构。
EngineVersion String 1.0

数据库版本,默认取值:1.0(自研,兼容Redis 5.0)。

SecondaryZoneId String cn-hangzhou-h

备可用区ID,可调用DescribeRegions查询。

说明
  • 本参数和ZoneId参数传入的值不能相同,且不可传入多可用区对应的ID。
  • 同时传入本参数和ZoneId后,主备节点会分别部署在指定的主可用区和备可用区,组成同城双中心主备架构。

返回数据

名称 类型 示例值 描述
Bandwidth Long 96

实例的最大带宽,单位:MB/s。

ChargeType String PrePaid

实例的付费类型,返回值固定为PrePaid(预付费,即包年包月)。

Config String {\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}

实例的详细配置,格式为JSON字符串。关于各参数的详细解释,请参见参数配置说明

ConnectionDomain String r-bp13ac3d047b****.tairpena.rds.aliyuncs.com

实例的内网连接地址。

Connections Long 10000

实例的最大连接数。

InstanceId String r-bp13ac3d047b****

实例ID。

InstanceName String redistest

实例名称。

说明 当传入了请求参数 InstanceName时,本参数才会返回。
InstanceStatus String Creating

实例当前的状态,返回值固定为Creating(创建中)。

Port Integer 6379

实例的端口号。

QPS Long 100000

每秒处理的最大读写操作数,单位为次/秒,此处为当前实例规格的理论值。

RegionId String cn-hangzhou

地域ID。

RequestId String 12123216-4B00-4378-BE4B-08005BFC****

请求ID。

TaskId String 10****

任务ID。

ZoneId String cn-hangzhou-h

可用区ID。

示例

请求示例

http(s)://r-kvstore.aliyuncs.com/?Action=CreateTairInstance
&InstanceClass=tair.scm.standard.4m.32d
&InstanceType=tair_scm
&RegionId=cn-hangzhou
&VpcId=vpc-bp1nme44gek34slfc****
&VSwitchId=vsw-bp1e7clcw529l773d****
&ZoneId=cn-hangzhou-e
&Period=1
&<公共请求参数>

正常返回示例

XML格式

<CreateTairInstanceResponse>
      <Connections>10000</Connections>
      <TaskId>10****</TaskId>
      <RequestId>F371C892-2143-4640-810E-74553F37****</RequestId>
      <ZoneId>cn-hangzhou-h</ZoneId>
      <InstanceId>r-bp13ac3d047b****</InstanceId>
      <Config>{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"list-max-ziplist-entries":512,"list-max-ziplist-value":64,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64}</Config>
      <Port>6379</Port>
      <InstanceName>redistest</InstanceName>
      <ConnectionDomain>r-bp13ac3d047b****.tairpena.rds.aliyuncs.com</ConnectionDomain>
      <QPS>100000</QPS>
      <InstanceStatus>Creating</InstanceStatus>
      <ChargeType>PrePaid</ChargeType>
      <Bandwidth>96</Bandwidth>
      <RegionId>cn-hangzhou</RegionId>
</CreateTairInstanceResponse>

JSON格式

{
	"Connections": 10000,
	"TaskId": "10****",
	"RequestId": "F371C892-2143-4640-810E-74553F37****",
	"ZoneId": "cn-hangzhou-h",
	"InstanceId": "r-bp13ac3d047b****",
	"Config": "{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}",
	"Port": 6379,
	"InstanceName": "redistest",
	"ConnectionDomain": "r-bp13ac3d047b****.tairpena.rds.aliyuncs.com",
	"QPS": 100000,
	"InstanceStatus": "Creating",
	"ChargeType": "PrePaid",
	"Bandwidth": 96,
	"RegionId": "cn-hangzhou"
}

错误码

HttpCode 错误码 错误信息 描述
400 InsufficientBalance Your account does not have enough balance. 账户余额不足,请先充值再操作。
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. 您的帐户还没有通过实名认证。
400 QuotaExceed.AfterpayInstance Living afterpay instances quota exceeded. 超过了支付实例配额。
400 InvalidCapacity.NotFound The Capacity provided does not exist in our records. Capacity 容量非法。
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 IzNotSupportVpcError Specify iz not support vpc. 指定 iz不支持Vpc。

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