AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

CreateTairInstance - 创建Tair（企业版）实例

更新时间：
复制为 MD 格式
产品详情
我的收藏

创建云原生版的Tair（企业版）实例。

接口说明

选型参考资料，请参见云数据库 Tair（兼容 Redis）选型必读。

请确保在使用该接口前，已充分了解云数据库 Tair（兼容 Redis）产品的收费方式和价格。

说明

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:CreateTairInstance

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/*
  • kvstore:InstanceClass
  • kvstore:InstanceType
 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

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

cn-hangzhou
InstanceName

string

否

实例名称，需满足下述要求：

  • 长度为 2~80 个字符。

  • 以大小写英文字母或中文开头，不支持空格和特殊字符：@/:=”<>{[]}。

apitest
Password

string

否

实例密码，需满足下述要求：

  • 长度为 8~32 位。

  • 需包含大写字母、小写字母、特殊字符和数字中的至少三种，支持的特殊字符为!@#$%^&*()_+-=。

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
SecondaryZoneId

string

否

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

说明

本参数和 ZoneId 参数传入的值不能相同，且不可传入多可用区对应的 ID。

cn-hangzhou-g
ChargeType

string

否

付费类型，取值：

  • PrePaid（默认）：预付费，即包年包月。

  • PostPaid：按量付费。

枚举值：

  • PostPaid :

    PostPaid

  • PrePaid :

    PrePaid

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。

说明

然后通过 BackupId、ClusterBackupId（云原生集群架构建议使用 ClusterBackupId）或 RestoreTime 参数指定需要使用的备份集或指定时间点，本参数需要与上述 3 个中的任意一个参数组合使用。

r-bp1zxszhcgatnx****
BackupId

string

否

您可在此参数中指定源实例的备份集 ID，系统将使用该备份集中保存的数据创建新实例。通过调用 DescribeBackups 可查询 BackupId。如果源实例是集群实例，则此处需要填写源实例各个分片的备份集 id，并且通过逗号隔开，例如"10**,11**,15**"。

说明

若您的实例是云原生架构实例，并且是集群实例，则建议您使用 DescribeClusterBackupList 查询出集群备份集 id，例如"cb-xx"，然后填入 ClusterBackupId 请求参数来达到克隆集群实例的目的，免去您输入各个分片备份集 id 的烦恼。

2158****20
ClusterBackupId

string

否

部分新集群架构支持集群备份集 ID，您可以通过 DescribeClusterBackupList 接口获取。

  • 若支持，可输入指定的集群备份集 ID 即可，无需再填写 BackupId 参数。

  • 若不支持，请在 BackupId 参数中填写为原实例各个分片下的备份集 ID，通过逗号隔开，例如"2158****20,2158****22"等。

cb-hyxdof5x9kqb****
RecoverConfigMode

string

否

使用指定备份集创建实例时，是否从原备份集中恢复账号（account）、内核参数（config）、白名单（whitelist）信息。例如需恢复账号信息，则取值为 account。

默认为空，表示不从原备份集中恢复账号、内核参数、白名单信息。

说明

本参数仅适用于云原生版实例，且需要原备份集中已保存了账号、内核参数、白名单信息。您可以通过 DescribeBackups 接口查询指定备份集中的 RecoverConfigMode 参数是否包含上述信息。

whitelist,config,account
PrivateIpAddress

string

否

指定实例的内网 IP 地址。

说明

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

172.16.88.***
AutoUseCoupon

string

否

是否使用代金券，取值：

  • true：使用代金券。

  • false（默认）：不使用代金券。

true
AutoRenew

string

否

是否开启自动续费，取值：

  • true：开启。

  • false（默认）：不开启。

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、essd_pl2、essd_pl3。

说明

当 InstanceType 取值为tair_essd时，且创建 ESSD 型时，才需要输入本参数。

essd_pl1
Storage

integer

否

磁盘型实例的存储空间，不同的规格取值范围有所区别，详情请参见磁盘型规格。

说明

当 InstanceType 取值为tair_essd时，且创建 ESSD 型时，才需要输入本参数。对于创建 Tair 磁盘 SSD 型实例，容量字段按不同的规格定义为不同的固定值，无需指定该字段。

60
ShardType

string

否

实例类型，取值：

  • MASTER_SLAVE（默认）：高可用，采用主备架构，可保障可用性。

  • STAND_ALONE：单副本，采用单节点架构。在节点故障后，数据会丢失，系统会自动拉起新的空实例。仅在单可用区时支持，且不支持创建集群与读写分离架构。

MASTER_SLAVE
ShardCount

integer

否

实例中的数据节点个数，取值：

  • 1：默认值，即表示创建的实例为标准架构，仅拥有 1 个数据节点。

  • 2~32：传入该范围的值，即表示创建的实例为集群架构，拥有指定数量的数据节点。

说明

当 InstanceType 取值为tair_rdb或tair_scm时，本参数才可以传入 2~32，即只有内存型和持久内存型支持集群架构。

2
ReplicaCount

integer

否

主可用区的备节点数，本参数仅适用于创建云原生版集群多副本实例，您可以通过该参数实现自定义备节点数量，取值：1~4。

说明

若创建多可用区实例，您可以通过该参数与 SlaveReplicaCount 参数自定义主、备可用区的备节点数量。同时，该参数与 SlaveReplicaCount 参数的总和不能超过 4。

2
SlaveReplicaCount

integer

否

备可用区的备节点数量。

2
ReadOnlyCount

integer

否

主可用区的只读节点数，本参数仅适用于创建云原生读写分离实例。

  • 若实例为标准架构，取值为 1~9。

  • 若实例为集群架构，取值为 1-4，表示每数据分片的只读节点数。

说明

若创建多可用区实例，您可以通过该参数和 SlaveReadOnlyCount 参数自定义主备可用区的只读节点数量。

  • 若实例为标准架构，该参数与 SlaveReadOnlyCount 的总和不能大于 9。

  • 若实例为集群架构，该参数与 SlaveReadOnlyCount 的总和不能大于 4。

5
SlaveReadOnlyCount

integer

否

备可用区的只读节点数量。

1
EngineVersion

string

否

数据库版本，默认取值：1.0，不同 Tair 产品类型传参规则：

  • Tair_rdb: Tair 内存型兼容 Redis 5.0、Redis 6.0 和 Redis 7.0 协议，传5.0、6.0或7.0。

  • Tair_scm: Tair 持久内存兼容 Redis 6.0 协议，传1.0。

  • Tair_essd: Tair 磁盘（ESSD/SSD）兼容 Redis 6.0 协议。 创建 ESSD 型请传入1.0、创建 SSD 型请传入2.0。

1.0
InstanceType

string

是

存储介质，取值：

  • tair_rdb：内存型。

  • tair_scm：持久内存型。

  • tair_essd：磁盘型。

tair_scm
GlobalInstanceId

string

否

是否将本次新建的实例作为分布式实例中的子实例，通过该方式可创建分布实例。

  • 若希望新建的实例作为第一个子实例，请输入 true。

  • 若希望新建的实例作为第二、三个子实例，请输入分布式实例 ID，例如 gr-bp14rkqrhac****。

  • 不作为分布式实例，您无需输入任何值。

说明

若希望作为分布式实例，本次新建的实例需为 Tair 内存型。

gr-bp14rkqrhac****
Tag

array<object>

否

实例的标签信息。

object

否

标签信息。

Key

string

否

标签的键，与 Tag Value 组成标签的键值对。

说明

单次最多支持传入 5 组标签的键值对。

key1_test
Value

string

否

标签的值。

说明

N 表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值；Tag.2.Value表示传入第二个标签的值。

value1_test
DryRun

boolean

否

是否对本次创建实例的操作执行预检查，取值：

  • true：执行预检查操作，不创建实例。检查项目包含请求参数、请求格式、业务限制和库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。

  • false（默认）：发送正常请求，通过检查后直接创建实例。

false
Port

integer

否

实例的服务端口，取值范围：1~65535，默认值为 6379。

6379
GlobalSecurityGroupIds

string

否

实例的全局 IP 白名单模板，多个 IP 白名单模板请用英文逗号（,）分隔，不可重复。

g-zsldxfiwjmti0kcm****
ParamGroupId

string

否

参数模板 ID，根据新创建的参数模板参数创建实例，不可重复。

g-50npzjcqb1ua6q6j****
RestoreTime

string

否

若源实例已开启数据闪回，您可在此参数中指定源实例备份保留周期内的任意时间点，系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2021-07-06T07:25:57Z
ConnectionStringPrefix

string

否

连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为 8~40 个字符。

说明

连接地址格式为：<前缀-实例 ID>.redis.rds.aliyuncs.com。

r-bp1zxszhcgatnx****
InstanceEndpointType

string

否

创建云原生双可用区读写分离实例时，使用的连接地址类型。不显式传该参数时，值默认为 AzIndependentEndpoint。

  • AzIndependentEndpoint : 默认值。可用区独立连接地址。主、备可用区分别提供独立连接地址，可通过不同的连接地址实现可用区就近访问。

  • UnifiedEndpoint : 统一连接地址。提供统一的连接地址，通过该地址同时访问到主备可用区的节点，但会出现跨可用区访问。

重要 该参数仅适用于云原生双可用区读写分离实例。对于其他类型实例，仅支持可用区独立连接地址，即使传入 UnifiedEndpoint 也不会真正生效。
重要 UnifiedEndpoint 参数目前仅面向白名单用户开放。非白名单用户传入该参数将导致调用报错。如需开通使用权限，请提交工单申请加白。

AzIndependentEndpoint
MaintainStartTime

string

否

设置实例可维护时段的开始时间，格式为HH:mmZ（UTC 时间）。例如，需要在北京时间凌晨 1 点开始，应设置为17:00Z。

说明

若不设置，值默认为 UTC 时间 18:00，即北京时间凌晨 2:00

MaintainEndTime

string

否

设置实例可维护时段的结束时间，格式为HH:mmZ（UTC 时间）。例如，需要在北京时间凌晨 2 点结束，应设置为18:00Z。

说明

开始时间和结束时间的间隔不能低于 1 小时。

说明

若不设置，值默认为 UTC 时间 22:00，即北京时间凌晨 6:00

返回参数

名称

类型

描述

示例值

object

对象。

QPS

integer

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

100000
ConnectionDomain

string

实例的内网连接地址。

r-bp13ac3d047b****.tairpena.rds.aliyuncs.com
ChargeType

string

实例的付费类型，返回值：

  • PrePaid：预付费。

  • PostPaid：按量付费。

PrePaid
InstanceId

string

实例 ID。

r-bp13ac3d047b****
Port

integer

实例的端口号。

6379
Config

string

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

{\"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

string

地域 ID。

cn-hangzhou
RequestId

string

请求 ID。

12123216-4B00-4378-BE4B-08005BFC****
Bandwidth

integer

实例的最大带宽，单位：MB/s。

96
Connections

integer

实例的最大连接数。

10000
InstanceName

string

实例名称。

说明

当传入了请求参数 InstanceName 时，本参数才会返回。

redistest
ZoneId

string

可用区 ID。

cn-hangzhou-h
InstanceStatus

string

实例当前的状态，返回值固定为 Creating（创建中）。

Creating
TaskId

string

任务 ID。

10****
OrderId

integer

订单 ID。

2084452111111

示例

正常返回示例

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.
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 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. 指定的地域Region无效
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 InvalidCapacity.NotFound The Capacity provided does not exist in our records. 所指定的存储规格不存在。
404 InvalidvSwitchId The Specified vSwitchId zone not supported.
404 InvalidVpcIdOrVswitchId.NotSupported The Specified vpcId or vSwitchId not supported.

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

变更历史

更多信息，参考变更详情。

上一篇：实例管理下一篇：CreateInstances - 批量创建实例