接口说明
请确保在使用该接口前，已充分了解云数据库 Tair（兼容 Redis）产品的收费方式和价格。
本接口可创建 Redis 开源版实例、Tair 内存型经典版实例，如需创建 Tair 云原生版实例，请调用 CreateTairInstance 接口。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
RegionIdstring | 地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
Tokenstring | 用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。 示例值:ETnLKlblzczshOTUbOCz**** |
InstanceNamestring | 实例名称。 名称为 2~80 个字符，以大小写字母或中文开头，不支持字符 示例值:apitest参考取值来源: CreateTairInstance DescribeInstances LockDBInstanceWrite UnlockDBInstanceWrite |
Passwordstring | 实例密码。 长度为 8－32 位，需包含大写字母、小写字母、特殊字符和数字中的至少三种，允许的特殊字符包括 示例值:Pass!123456 |
Capacityinteger<int64> | |
InstanceClassstring | |
ZoneIdstring | 主可用区 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的可用区。展开详情 示例值:cn-hangzhou-h参考取值来源: DescribeZones |
SecondaryZoneIdstring | 备可用区 ID，可调用 DescribeZones 接口查询。展开详情 示例值:cn-hangzhou-g |
ChargeTypestring | 付费类型，取值：展开详情 示例值:PostPaid枚举值:PrePaidPostPaid |
NodeTypestring | 节点类型，取值：展开详情 示例值:STAND_ALONE枚举值:STAND_ALONEMASTER_SLAVEdoublesingle |
NetworkTypestring | 网络类型，取值：展开详情 示例值:VPC枚举值:VPC |
VpcIdstring | VPC 网络的 ID。 示例值:vpc-bp1nme44gek34slfc**** |
VSwitchIdstring | 虚拟交换机的 ID。 示例值:vsw-bp1e7clcw529l773d**** |
Periodstring | 付费周期，单位为月，取值：1~9、12、24、36、60 。展开详情 示例值:12正则:^\d+$ |
BusinessInfostring | 活动 ID、业务信息。 示例值:000000000 |
CouponNostring | 优惠码，默认值为： 示例值:youhuiquan_promotion_option_id_for_blank |
SrcDBInstanceIdstring | 如需基于某个实例的备份集创建新实例，请先在此参数中指定源实例 ID。展开详情 示例值:r-bp1zxszhcgatnx**** |
BackupIdstring | 您可在此参数中指定源实例的备份集 ID，系统将使用该备份集中保存的数据创建新实例。通过调用 DescribeBackups 可查询 BackupId。如果源实例是集群实例，则此处需要填写源实例各个分片的备份集 id，并且通过逗号隔开，例如"10**,11**,15**"。展开详情 示例值:111111111参考取值来源: DescribeBackups |
InstanceTypestring | 实例类型，取值：展开详情 示例值:Redis枚举值:RedisMemcache参考取值来源: CreateTairInstance DescribeInstances |
EngineVersionstring | Redis经典版本，版本号取值：展开详情 示例值:5.0枚举值:4.05.06.07.02.8 |
PrivateIpAddressstring | 指定新实例的内网 IP 地址。展开详情 示例值:172.16.0.*** |
AutoUseCouponstring | 是否使用代金券，取值：展开详情 示例值:false |
AutoRenewstring | 是否开启自动续费，取值：展开详情 示例值:true枚举值:truefalse |
AutoRenewPeriodstring | 自动续费周期，单位为月，取值：1、2、3、6、12。展开详情 示例值:3 |
ResourceGroupIdstring | 资源组 ID。 示例值:rg-resourcegroupid1 |
RestoreTimestring | 若源实例已开启数据闪回，您可在此参数中指定源实例备份保留周期内的任意时间点，系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 示例值:2019-06-19T16:00:00Z |
DedicatedHostGroupIdstring | 专属集群 ID，在专属集群内创建 Redis 实例时需传入本参数。 示例值:dhg-uv4fnk6r7zff**** |
ShardCountinteger<int32> | 分片数，本参数仅适用于创建云原生版集群架构实例，您可以通过该参数实现自定义分片数量。 示例值:4取值 <= 128 |
ReplicaCountinteger<int32> | 主可用区的备节点，本参数仅适用于创建云原生版集群多副本实例，您可以通过该参数实现自定义备节点数量，取值：1~4。展开详情 示例值:2取值 >= 0 |
SlaveReplicaCountinteger<int32> | 备可用区的备节点数量。 示例值:2取值 >= 0 |
ReadOnlyCountinteger<int32> | 主可用区的只读节点数，本参数仅适用于创建云原生读写分离实例。展开详情 示例值:2取值 <= 5 |
SlaveReadOnlyCountinteger<int32> | 备可用区的只读节点数量。 示例值:2取值 >= 0 |
GlobalInstanceIdstring | 分布式实例 ID，本参数仅适用于中国站。展开详情 示例值:gr-bp14rkqrhac****参考取值来源: DescribeInstances |
GlobalInstanceboolean | 是否将本次新建的实例作为分布式实例中的第一个子实例，通过该方式可创建分布实例，取值：展开详情 示例值:false |
Portstring | 实例的服务端口，取值范围：1~65535，默认值为 6379。 示例值:6379正则:^\d+$字符长度 <= 5字符长度 >= 1 |
DryRunboolean | 是否对本次创建实例的操作执行预检查，取值：展开详情 示例值:false |
GlobalSecurityGroupIdsstring | 实例的全局 IP 白名单模板，多个 IP 白名单模板请用英文逗号（,）分隔，不可重复。展开详情 示例值:g-zsldxfiwjmti0kcm****参考取值来源: DescribeGlobalSecurityIPGroup CreateGlobalSecurityIPGroup |
Appendonlystring | 指定新创建实例的 AOF 参数配置，取值：展开详情 示例值:yes枚举值:noyes |
ConnectionStringPrefixstring | 连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为 8~40 个字符。展开详情 示例值:r-bp1zxszhcgatnx****参考取值来源: AllocateInstancePublicConnection |
ParamGroupIdstring | 参数模板 ID，全局唯一。 示例值:rpg-test**参考取值来源: ModifyParameterGroup CreateParameterGroup DescribeParameterGroup |
Tagarray<object> | 实例的标签信息。 子级条数 <= 21 |
ClusterBackupIdstring | 部分新集群架构支持集群备份集 ID，您可以通过 DescribeClusterBackupList 接口获取。展开详情 示例值:cb-hyxdof5x9kqb****参考取值来源: DescribeClusterBackupList |
RecoverConfigModestring | 使用指定备份集创建实例时，是否从原备份集中恢复账号（account）、内核参数（whitelist）、白名单（config）信息。例如需恢复账号信息，则取值为 示例值:{"whitelist":true,"config":true,"account":true} |
请求说明
创建 Redis 7.0 集群架构的请求示例如下。
{
"RegionId": "cn-shenzhen",
"InstanceName": "apitest",
"Password": "D****23",
"ZoneId": "cn-shenzhen-f",
"ChargeType": "PrePaid",
"InstanceClass": "redis.shard.with.proxy.small.ce",
"NetworkType": "VPC",
"Period": "1",
"InstanceType": "Redis",
"EngineVersion": "7.0",
"ShardCount": 4,
"SourceIp": "10.10.10.10"
}返回参数
| 字段名称 | 字段详情 |
|---|---|
VpcIdstring | 专有网络（VPC）的 ID。 示例值:vpc-bp1nme44gek34slfc**** |
QPSinteger<int64> | 每秒访问次数，此处为当前规格实例的理论值。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:100000 |
Capacityinteger<int64> | 实例的存储容量，单位：MB。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:16384 |
ConnectionDomainstring | Redis 实例的内网连接地址。 示例值:r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
ChargeTypestring | 付费类型，返回值：展开详情 示例值:PostPaid |
NetworkTypestring | 网络类型，返回值：展开详情 示例值:VPC |
InstanceIdstring | 实例 ID（全局唯一）。 示例值:r-bp1zxszhcgatnx**** |
Portinteger<int32> | Redis 服务端口。 示例值:6379 |
Configstring | 实例的详细配置。 示例值:{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64} |
RegionIdstring | 实例所在地域。 示例值:cn-hongkong |
EndTimestring | 预付费实例到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 示例值:2019-01-18T16:00:00Z |
VSwitchIdstring | 虚拟交换机 ID。 示例值:vsw-bp1e7clcw529l773d**** |
RequestIdstring | 请求 ID。 示例值:5DEA3CC9-F81D-4387-8E97-CEA40F09**** |
NodeTypestring | 节点类型，返回值：展开详情 示例值:MASTER_SLAVE |
Connectionsinteger<int64> | 实例连接数限制。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:10000 |
Bandwidthinteger<int64> | 实例带宽限制，单位：MB/s。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:32 |
InstanceNamestring | 实例名称。 示例值:apitest |
ZoneIdstring | 实例所属的可用区的 ID。 示例值:cn-hangzhou-b |
InstanceStatusstring | 实例的当前状态，返回值固定为 Creating（创建中）。 示例值:Creating |
PrivateIpAddrstring | 实例的内网 IP 地址。 示例值:172.16.0.10 |
UserNamestring | 连接 Redis 的账号，默认包含一个以实例 ID 命名的账号。 示例值:r-bp1zxszhcgatnx**** |
OrderIdinteger<int64> | 订单 id。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:2084452111111 |