创建Tair版实例。
接口说明
选型参考资料,请参见阿里云Redis产品选型必读。
请确保在使用该接口前,已充分了解云数据库Redis产品的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:CreateTairInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID,可调用DescribeRegions查询,使用此参数指定要创建实例的地域。 | cn-hangzhou |
InstanceName | string | 否 | 实例名称,需满足下述要求:
| apitest |
Password | string | 否 | 实例密码,需满足下述要求:
| Pass!123456 |
InstanceClass | string | 是 | 实例规格,更多信息,请参见: | tair.scm.standard.4m.32d |
ZoneId | string | 是 | 主可用区ID,可调用DescribeRegions查询,使用此参数指定要创建实例的可用区。 说明
您也可以再传入SecondaryZoneId参数指定备可用区,主备节点将分别部署在指定的主可用区和备可用区,实现同城双中心主备架构。例如指定ZoneId参数为"cn-hangzhou-h",指定SecondaryZoneId参数为"cn-hangzhou-g"。
| cn-hangzhou-h |
ChargeType | string | 否 | 付费类型,取值:
| PrePaid |
VpcId | string | 是 | 专有网络ID,可调用专有网络VPC的DescribeVpcs获取。 | vpc-bp1nme44gek34slfc**** |
VSwitchId | string | 是 | 该专有网络下的虚拟交换机ID,可调用专有网络VPC的DescribeVpcs获取。 | vsw-bp1e7clcw529l773d**** |
Period | integer | 否 | 付费周期,单位为月,取值:1~9、12、24、36、60 。 说明
当ChargeType取值为PrePaid时,本参数必须传入。
| 1 |
BusinessInfo | string | 否 | 活动ID、业务信息。 | 000000000 |
CouponNo | string | 否 | 优惠码。 | youhuiquan_promotion_option_id_for_blank |
SrcDBInstanceId | string | 否 | 源实例ID。 说明
如需基于某个实例的备份集创建新实例,请先在此参数中指定源实例ID,然后通过BackupId参数指定需要使用的备份集。
| r-bp1zxszhcgatnx**** |
BackupId | string | 否 | 源实例的备份集ID,可调用DescribeBackups获取。 说明
如需基于某个实例的备份数据创建新实例,在通过SrcDBInstanceId指定源实例ID后,您还需传入本参数指定源实例的备份集ID,系统将使用该备份集中保存的数据创建新实例。
| 11111111 |
PrivateIpAddress | string | 否 | 指定实例的内网IP地址。 说明
该地址需在实例所属交换机的网段内,您可以调用专有网络VPC的DescribeVSwitches获取网段信息。
| 172.16.88.*** |
AutoUseCoupon | string | 否 | 是否使用代金券,取值:
| true |
AutoRenew | string | 否 | 是否开启自动续费,取值:
| true |
AutoRenewPeriod | string | 否 | 自动续费周期,单位为月,取值:1、2、3、6、12。 说明
当AutoRenew取值为true时,本参数必须传入。
| 3 |
ResourceGroupId | string | 否 | 目标资源组ID。 说明
| rg-acfmyiu4ekp**** |
AutoPay | boolean | 否 | 自动支付,取值固定为true。 | true |
ClientToken | string | 否 | 用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感、不超过64个ASCII字符。 | ETnLKlblzczshOTUbOCz**** |
StorageType | string | 否 | 存储类型,取值固定为essd_pl1。 说明
当InstanceType取值为tair_essd时,本参数才可用。
| essd_pl1 |
Storage | integer | 否 | 云盘的存储空间,不同的规格取值范围有所区别,详情请参见云盘(ESSD)型规格。 说明
当InstanceType取值为tair_essd时,本参数才可用且必须传入。
| 60 |
ShardType | string | 否 | 实例类型,取值:
| MASTER_SLAVE |
ShardCount | integer | 否 | 1 | |
ReadOnlyCount | integer | 否 | 只读节点数,本参数仅适用于创建云盘版读写分离架构实例,您可以通过该参数实现自定义只读节点数量,取值:1~5。 | 5 |
EngineVersion | string | 否 | 数据库版本,默认取值:1.0(自研,兼容Redis 5.0)。 | 1.0 |
InstanceType | string | 是 | 存储介质,取值:
| tair_scm |
SecondaryZoneId | string | 否 | 备可用区ID,可调用DescribeRegions查询。 说明
本参数和ZoneId参数传入的值不能相同,且不可传入多可用区对应的ID。
| cn-hangzhou-g |
GlobalInstanceId | string | 否 | 分布式实例ID。 | gr-bp14rkqrhac**** |
Tag | object [] | 否 | 实例的标签信息。 | |
Key | string | 否 | 标签的键,与Tag Value组成标签的键值对。 说明
单次最多支持传入5组标签的键值对。
| key1_test |
Value | string | 否 | 标签的值。 说明
N表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值;Tag.2.Value表示传入第二个标签的值。
| value1_test |
DryRun | boolean | 否 | 是否对本次创建实例的操作执行预检查,取值:
| false |
Port | integer | 否 | 实例的服务端口,取值范围:1024~65535,默认值为6379。 | 6379 |
GlobalSecurityGroupIds | string | 否 | 实例的全局IP白名单模板,多个IP白名单模板请用英文逗号(,)分隔,不可重复。 | g-zsldxfiwjmti0kcm**** |
ParamGroupId | string | 否 | 参数模板ID,根据新创建的参数模板参数创建实例,不可重复。 | g-50npzjcqb1ua6q6j**** |
返回参数
示例
正常返回示例
JSON
格式
{
"QPS": 100000,
"ConnectionDomain": "r-bp13ac3d047b****.tairpena.rds.aliyuncs.com",
"ChargeType": "PrePaid",
"InstanceId": "r-bp13ac3d047b****",
"Port": 6379,
"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}",
"RegionId": "cn-hangzhou",
"RequestId": "12123216-4B00-4378-BE4B-08005BFC****",
"Bandwidth": 96,
"Connections": 10000,
"InstanceName": "redistest",
"ZoneId": "cn-hangzhou-h",
"InstanceStatus": "Creating",
"TaskId": "10****",
"OrderId": 2084452111111
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | - |
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. | 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 | VpcServiceError | Invoke vpc service failed. | - |
400 | IzNotSupportVpcError | Specify iz not support vpc. | 指定 iz不支持Vpc。 |
400 | InvalidvSwitchId | The vpc does not cover the vswitch. | - |
400 | InvalidIzNo.NotSupported | The Specified vpc zone not supported. | - |
400 | InvalidAccountPassword.Format | Specified account password is not valid. | - |
400 | InstanceClass.NotMatch | Current instance class and instance type is not match. | - |
400 | InvalidVPCId.NotFound | Specified virtual vpc is not found. | VPC未找到,建议检查VPC ID是否正确。 |
400 | AccountMoneyValidateError | Account money validate error. | - |
400 | RequestTokenConflict | Specified request token conflict. | - |
400 | InvalidIPNotInSubnet | Error ip not in subnet. | - |
400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | 无效的引擎版本 |
400 | Zone.Closed | The specified zone is closed. | - |
400 | VSwithNotBelongToNotVpcFault | The vSwitch does not belong to current vpc. | - |
400 | PayIllegalAgreement | Pay mayi with holding agreement illegal. | - |
400 | IllegalParamError | validateSaleConditionWithSubArticle failed. | - |
400 | CASH_BOOK_INSUFFICIENT | No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000. | - |
400 | InvalidRegion.Format | Specified Region is not valid. | - |
403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | 您的帐户还没有通过实名认证。 |
403 | AuthorizationFailure | The request processing has failed due to authorization failure. | - |
403 | TokenServiceError | The specified token is duplicated, please change it. | - |
403 | UserCannotBuyNotInnerCommodity | The user can not buy this commodity without alibaba group tag. | - |
404 | InvalidvSwitchId | The Specified vSwitchId zone not supported. | - |
404 | InvalidVpcIdOrVswitchId.NotSupported | The Specified vpcId or vSwitchId not supported. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-14 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-07-25 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-06-21 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-06-21 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-04-03 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-11-14 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-07-27 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-06-15 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
|