接口说明
选型参考资料，请参见云数据库 Tair（兼容 Redis）选型必读。
请确保在使用该接口前，已充分了解云数据库 Tair（兼容 Redis）产品的收费方式和价格。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
RegionIdstring | 地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
InstanceNamestring | 实例名称，需满足下述要求：展开详情 示例值:apitest参考取值来源: CreateInstance DescribeInstances LockDBInstanceWrite UnlockDBInstanceWrite |
Passwordstring | 实例密码，需满足下述要求：展开详情 示例值:Pass!123456 |
InstanceClassstring | 实例规格，更多信息，请参见：展开详情 示例值:tair.scm.standard.4m.32d参考取值来源: DescribeInstances |
ZoneIdstring | 主可用区 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的可用区。展开详情 示例值:cn-hangzhou-h参考取值来源: DescribeZones |
SecondaryZoneIdstring | 备可用区 ID，可调用 DescribeRegions 查询。展开详情 示例值:cn-hangzhou-g |
ChargeTypestring | 付费类型，取值：展开详情 示例值:PrePaid枚举值:PostPaidPrePaid |
VpcIdstring | 专有网络 ID，可调用专有网络 VPC 的 DescribeVpcs 获取。 示例值:vpc-bp1nme44gek34slfc**** |
VSwitchIdstring | 该专有网络下的虚拟交换机 ID，可调用专有网络 VPC 的 DescribeVpcs 获取。 示例值:vsw-bp1e7clcw529l773d**** |
Periodinteger<int32> | 付费周期，单位为月，取值：1~9、12、24、36、60 。展开详情 示例值:1 |
BusinessInfostring | 活动 ID、业务信息。 示例值:000000000 |
CouponNostring | 优惠码。 示例值:youhuiquan_promotion_option_id_for_blank |
SrcDBInstanceIdstring | 如需基于某个实例的备份集创建新实例，请先在此参数中指定源实例 ID。展开详情 示例值:r-bp1zxszhcgatnx**** |
BackupIdstring | 您可在此参数中指定源实例的备份集 ID，系统将使用该备份集中保存的数据创建新实例。通过调用 DescribeBackups 可查询 BackupId。如果源实例是集群实例，则此处需要填写源实例各个分片的备份集 id，并且通过逗号隔开，例如"10**,11**,15**"。展开详情 示例值:2158****20参考取值来源: DescribeBackups |
ClusterBackupIdstring | 部分新集群架构支持集群备份集 ID，您可以通过 DescribeClusterBackupList 接口获取。展开详情 示例值:cb-hyxdof5x9kqb****参考取值来源: DescribeClusterBackupList |
RecoverConfigModestring | 使用指定备份集创建实例时，是否从原备份集中恢复账号（account）、内核参数（whitelist）、白名单（config）信息。例如需恢复账号信息，则取值为 示例值:{"whitelist":true,"config":true,"account":true} |
PrivateIpAddressstring | 指定实例的内网 IP 地址。展开详情 示例值:172.16.88.*** |
AutoUseCouponstring | 是否使用代金券，取值：展开详情 示例值:true |
AutoRenewstring | 是否开启自动续费，取值：展开详情 示例值:true |
AutoRenewPeriodstring | 自动续费周期，单位为月，取值：1、2、3、6、12。展开详情 示例值:3 |
ResourceGroupIdstring | 目标资源组 ID。展开详情 示例值:rg-acfmyiu4ekp**** |
AutoPayboolean | 自动支付，取值固定为 true。 示例值:true枚举值:true |
ClientTokenstring | 用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。 示例值:ETnLKlblzczshOTUbOCz**** |
StorageTypestring | 存储类型，取值为essd_pl1、essd_pl2、essd_pl3。展开详情 示例值:essd_pl1枚举值:essd_pl0essd_pl1essd_pl2essd_pl3 |
Storageinteger<int32> | |
ShardTypestring | 实例类型，取值：展开详情 示例值:MASTER_SLAVE枚举值:STAND_ALONEMASTER_SLAVE |
ShardCountinteger<int32> | 实例中的数据节点个数，取值：展开详情 示例值:2取值 <= 64 |
ReplicaCountinteger<int32> | 主可用区的备节点数，本参数仅适用于创建云原生版集群多副本实例，您可以通过该参数实现自定义备节点数量，取值：1~4。展开详情 示例值:2取值 >= 0 |
SlaveReplicaCountinteger<int32> | 备可用区的备节点数量。 示例值:2取值 >= 0 |
ReadOnlyCountinteger<int32> | 主可用区的只读节点数，本参数仅适用于创建云原生读写分离实例。展开详情 示例值:5取值 <= 5 |
SlaveReadOnlyCountinteger<int32> | 备可用区的只读节点数量。 示例值:1 |
EngineVersionstring | 数据库版本，默认取值：1.0，不同 Tair 产品类型传参规则：展开详情 示例值:1.0枚举值:1.05.06.02.07.0 |
InstanceTypestring | 存储介质，取值：展开详情 示例值:tair_scm枚举值:tair_scmtair_essdtair_rdbRedistair_skv参考取值来源: DescribeInstances |
GlobalInstanceIdstring | 是否将本次新建的实例作为分布式实例中的子实例，通过该方式可创建分布实例。展开详情 示例值:gr-bp14rkqrhac****参考取值来源: DescribeInstances |
Tagarray<object> | 实例的标签信息。 子级条数 <= 21 |
DryRunboolean | 是否对本次创建实例的操作执行预检查，取值：展开详情 示例值:false |
Portinteger<int32> | 实例的服务端口，取值范围：1~65535，默认值为 6379。 示例值:6379取值 <= 65535 |
GlobalSecurityGroupIdsstring | 实例的全局 IP 白名单模板，多个 IP 白名单模板请用英文逗号（,）分隔，不可重复。 示例值:g-zsldxfiwjmti0kcm****参考取值来源: DescribeGlobalSecurityIPGroup CreateGlobalSecurityIPGroup |
ParamGroupIdstring | 参数模板 ID，根据新创建的参数模板参数创建实例，不可重复。 示例值:g-50npzjcqb1ua6q6j****参考取值来源: ModifyParameterGroup CreateParameterGroup DescribeParameterGroup |
RestoreTimestring | 若源实例已开启数据闪回，您可在此参数中指定源实例备份保留周期内的任意时间点，系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 示例值:2021-07-06T07:25:57Z |
ConnectionStringPrefixstring | 连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为 8~40 个字符。展开详情 示例值:r-bp1zxszhcgatnx****参考取值来源: AllocateInstancePublicConnection |
返回参数
| 字段名称 | 字段详情 |
|---|---|
QPSinteger<int64> | 每秒处理的最大读写操作数，单位为次/秒，此处为当前实例规格的理论值。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:100000 |
ConnectionDomainstring | 实例的内网连接地址。 示例值:r-bp13ac3d047b****.tairpena.rds.aliyuncs.com |
ChargeTypestring | 实例的付费类型，返回值：展开详情 示例值:PrePaid |
InstanceIdstring | 实例 ID。 示例值:r-bp13ac3d047b**** |
Portinteger<int32> | 实例的端口号。 示例值:6379 |
Configstring | 实例的详细配置，格式为 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} |
RegionIdstring | 地域 ID。 示例值:cn-hangzhou |
RequestIdstring | 请求 ID。 示例值:12123216-4B00-4378-BE4B-08005BFC**** |
Bandwidthinteger<int64> | 实例的最大带宽，单位：MB/s。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:96 |
Connectionsinteger<int64> | 实例的最大连接数。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:10000 |
InstanceNamestring | 实例名称。展开详情 示例值:redistest |
ZoneIdstring | 可用区 ID。 示例值:cn-hangzhou-h |
InstanceStatusstring | 实例当前的状态，返回值固定为 Creating（创建中）。 示例值:Creating |
TaskIdstring | 任务 ID。 示例值:10**** |
OrderIdinteger<int64> | 订单 ID。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:2084452111111 |