文档

CreateInstance - 创建一个Redis实例

更新时间:

创建一个Redis实例。

接口说明

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

本接口可创建 Redis 实例、Tair 内存型经典版实例,如需创建 Tair 云原生版实例,请调用 CreateTairInstance 接口。

说明 该 API 对应的控制台操作方法和选型建议,请参见创建 Redis 实例

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:CreateInstanceWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/*
  • kvstore:InstanceClass
  • kvstore:Appendonly
  • kvstore:InstanceType

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
Tokenstring

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

ETnLKlblzczshOTUbOCz****
InstanceNamestring

实例名称。 名称为 2~80 个字符,以大小写字母或中文开头,不支持字符@/:=”<>{[]}和空格。

apitest
Passwordstring

实例密码。 长度为 8-32 位,需包含大写字母、小写字母、特殊字符和数字中的至少三种,允许的特殊字符包括!@#$%^&*()_+-=

Pass!123456
Capacitylong

实例的存储容量,单位为 MB。

说明 调用此接口需至少传递 CapacityInstanceClass 中的一个参数。
16384
InstanceClassstring

实例的规格,例如 redis.master.small.default 为社区版(经典版)标准架构双副本 1GB 实例,详细信息请参见规格查询导航

说明 调用此接口需至少传递 CapacityInstanceClass 中的一个参数。
redis.master.small.default
ZoneIdstring

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

说明 您也可以再传入 SecondaryZoneId 参数指定备可用区,主备节点将分别部署在指定的主可用区和备可用区,实现同城双中心主备架构。例如指定 ZoneId 参数为"cn-hangzhou-h",指定 SecondaryZoneId 参数为"cn-hangzhou-g"。
cn-hangzhou-h
ChargeTypestring

付费类型,取值:

  • PrePaid:预付费。
  • PostPaid(默认):按量付费。
PostPaid
NodeTypestring

节点类型,取值:

  • MASTER_SLAVE:高可用(双副本)
  • STAND_ALONE:单副本
  • double:双副本
  • single:单副本
说明 云原生版实例请选择MASTER_SLAVESTAND_ALONE,经典版实例请选择 doublesingle
STAND_ALONE
NetworkTypestring

网络类型,取值:

  • VPC:专有网络,默认值。
VPC
VpcIdstring

VPC 网络的 ID。

vpc-bp1nme44gek34slfc****
VSwitchIdstring

虚拟交换机的 ID。

vsw-bp1e7clcw529l773d****
Periodstring

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

说明 ChargeType 取值为 PrePaid 时,本参数才可用且必须传入。
12
BusinessInfostring

活动 ID、业务信息。

000000000
CouponNostring

优惠码,默认值为:default

youhuiquan_promotion_option_id_for_blank
SrcDBInstanceIdstring

如需基于某个实例的备份集创建新实例,请先在此参数中指定源实例 ID。

说明 然后通过 BackupIdClusterBackupId(云原生集群架构建议使用 ClusterBackupId)或 RestoreTime 参数指定需要使用的备份集或指定时间点,本参数需要与上述 3 个中的任意一个参数组合使用。
r-bp1zxszhcgatnx****
BackupIdstring

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

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

111111111
InstanceTypestring

实例类型,取值:

  • Redis(默认)
  • Memcache
Redis
EngineVersionstring

Redis经典版本,版本号取值:

Redis云原生版本,版本号取值:

  • 5.0
  • 6.0(推荐)
  • 7.0
说明 默认值为5.0
5.0
PrivateIpAddressstring

指定新实例的内网 IP 地址。

说明 内网 IP 需在实例所属的交换机网段内。
172.16.0.***
AutoUseCouponstring

是否使用代金券,取值:

  • true:使用代金券。
  • false(默认):不使用代金券。
false
AutoRenewstring

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

  • true:开启。
  • false(默认):不开启。
true
AutoRenewPeriodstring

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

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

资源组 ID。

rg-resourcegroupid1
RestoreTimestring

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

2019-06-19T16:00:00Z
DedicatedHostGroupIdstring

专属集群 ID,在专属集群内创建 Redis 实例时需传入本参数。

dhg-uv4fnk6r7zff****
ShardCountinteger

分片数,本参数仅适用于创建云盘版集群架构实例,您可以通过该参数实现自定义分片数量。

4
ReadOnlyCountinteger

主可用区的只读节点数,本参数仅适用于创建云盘版读写分离架构实例,您可以通过该参数实现自定义只读节点数量,取值:1~9。

说明 但该参数与 SlaveReadOnlyCount 的总和不能大于 9。
5
GlobalInstanceIdstring

分布式实例 ID,本参数仅适用于中国站。

如需将新创建的 Redis 实例追加为分布式实例中的新子实例,本参数才可用且必须传入。相关说明与控制台操作,请参见为分布式实例添加子实例

gr-bp14rkqrhac****
GlobalInstanceboolean

是否将本次新建的实例作为分布式实例中的第一个子实例,通过该方式可创建分布实例,取值:

  • true:作为第一个子实例。
  • false(默认):不作为第一个子实例。
说明
  • 如需传入 true,本次新建的实例需为 Tair 内存型,引擎版本为 5.0。
  • 本参数仅适用于中国站。
  • false
    SecondaryZoneIdstring

    备可用区 ID,可调用 DescribeZones 接口查询。

    说明 本参数和 ZoneId 参数传入的值不能相同,且不可传入多可用区对应的 ID。
    cn-hangzhou-g
    Portstring

    实例的服务端口,取值范围:1024~65535,默认值为 6379

    6379
    DryRunboolean

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

    • true:执行预检查操作,不创建实例。检查项目包含请求参数、请求格式、业务限制和库存。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
    • false(默认):发送正常请求,通过检查后直接创建实例。
    false
    GlobalSecurityGroupIdsstring

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

    g-zsldxfiwjmti0kcm****
    Appendonlystring

    指定新创建实例的 AOF 参数配置,取值:

    • yes(默认):开启 AOF 持久化。
    • no:关闭 AOF 持久化。
    说明 该参数适用于经典版实例,云原生版实例暂不支持指定 AOF 参数。
    yes
    ConnectionStringPrefixstring

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

    说明 连接地址格式为:<前缀>.redis.rds.aliyuncs.com。
    r-bp1zxszhcgatnx****
    ParamGroupIdstring

    参数模板 ID,全局唯一。

    rpg-test**
    Tagobject []

    实例的标签信息。

    Keystring

    标签的键。

    说明
  • N 表示传入第几个标签的键,单个实例最多可绑定 20 个标签。例如 Tag.1.Key 表示传入第一个标签的键;Tag.2.Key 表示传入第二个标签的键。
  • 如果标签的键不存在,则自动创建。
  • testkey
    Valuestring

    标签的值。

    说明 N 表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值;Tag.2.Value表示传入第二个标签的值。
    testvalue
    ClusterBackupIdstring

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

    • 若支持,可输入指定的集群备份集 ID 即可,无需再填写 BackupId 参数。
    • 若不支持,请在 BackupId 参数中填写为原实例各个分片下的备份集 ID,通过逗号隔开,例如"2158****20,2158****22"等。
    cb-hyxdof5x9kqb****
    SlaveReadOnlyCountinteger

    用于多可用区读写分离实例创建时,指定备可用区的只读节点数量。该参数与 ReadOnlyCount 的总和不能大于 9。

    注意 创建多可用区读写分离实例时需要同时指定 SlaveReadOnlyCount 和 SecondaryZoneId 参数。

    2

    创建 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"
    }

    返回参数

    名称类型描述示例值
    object

    对象。

    VpcIdstring

    专有网络(VPC)的 ID。

    vpc-bp1nme44gek34slfc****
    QPSlong

    每秒访问次数,此处为当前规格实例的理论值。

    100000
    Capacitylong

    实例的存储容量,单位:MB。

    16384
    ConnectionDomainstring

    Redis 实例的内网连接地址。

    r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    ChargeTypestring

    付费类型,返回值:

    • PrePaid:预付费。
    • PostPaid:按量付费。
    PostPaid
    NetworkTypestring

    网络类型,返回值:

    • CLASSIC:经典网络。
    • VPC:专有网络。
    VPC
    InstanceIdstring

    实例 ID(全局唯一)。

    r-bp1zxszhcgatnx****
    Portinteger

    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

    节点类型,返回值:

    • STAND_ALONE:单副本。
    • MASTER_SLAVE:双副本。
    MASTER_SLAVE
    Connectionslong

    实例连接数限制。

    10000
    Bandwidthlong

    实例带宽限制,单位:MB/s。

    32
    InstanceNamestring

    实例名称。

    apitest
    ZoneIdstring

    实例所属的可用区的 ID。

    cn-hangzhou-b
    InstanceStatusstring

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

    Creating
    PrivateIpAddrstring

    实例的内网 IP 地址。

    172.16.0.10
    UserNamestring

    连接 Redis 的账号,默认包含一个以实例 ID 命名的账号。

    r-bp1zxszhcgatnx****
    OrderIdlong

    订单 id。

    2084452111111

    示例

    正常返回示例

    JSON格式

    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "QPS": 100000,
      "Capacity": 16384,
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PostPaid",
      "NetworkType": "VPC",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "Port": 6379,
      "Config": "{\\\"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}",
      "RegionId": "cn-hongkong",
      "EndTime": "2019-01-18T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "RequestId": "5DEA3CC9-F81D-4387-8E97-CEA40F09****",
      "NodeType": "MASTER_SLAVE",
      "Connections": 10000,
      "Bandwidth": 32,
      "InstanceName": "apitest",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Creating",
      "PrivateIpAddr": "172.16.0.10",
      "UserName": "r-bp1zxszhcgatnx****",
      "OrderId": 2084452111111
    }

    错误码

    HTTP status code错误码错误信息描述
    400ZoneIdNotFoundSpecify iz not support switch network.-
    400InvalidShardInfo.FormatShard total number is out of range.-
    400InvalidInstancelevelSpecified Instance level dose not match gdc other member instance level.-
    400InvalidBackupLogStatusBackup logs are not enabled for the specified source instance.-
    400InvalidStatusSpecified instance status is Modifying.-
    400SecurityRisk.AuthVerificationwe have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton.-
    400MissingParameterPeriod is mandatory for this action.-
    400InvalidToken.MalformedThe Specified parameter Token is not valid.-
    400InvalidInstanceName.MalformedThe Specified parameter InstanceName is not valid.-
    400InvalidPassword.MalformedThe Specified parameter Password is not valid.-
    400InsufficientBalanceYour account does not have enough balance.账户余额不足,请先充值再操作。
    400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.超过了支付实例配额。
    400InvalidCapacity.NotFoundThe Capacity provided does not exist in our records.Capacity 容量非法。
    400ResourceNotAvailableResource you requested is not available for finance user.您所请求的资源对财务用户来说是不可用的。
    400PaymentMethodNotFoundNo payment method has been registered on the account.帐户上没有登记付款方法。
    400IdempotentParameterMismatchRequest uses a client token in a previous request but is not identical to that request.幂等性校验不过
    400QuotaNotEnoughQuota not enough in this zone.这个区域的配额是不够的。
    400QuotaExceedLiving afterpay instances quota exceed.超过了支付实例配额。
    400VpcServiceErrorInvoke vpc service failed.-
    400IzNotSupportVpcErrorSpecify iz not support vpc.指定 iz不支持Vpc。
    400InvalidvSwitchIdThe vpc does not cover the vswitch.-
    400InvalidIzNo.NotSupportedThe Specified vpc zone not supported.-
    400InvalidAccountPassword.FormatSpecified account password is not valid.-
    400InstanceClass.NotMatchCurrent instance class and instance type is not match.-
    400InvalidVPCId.NotFoundSpecified virtual vpc is not found.VPC未找到,建议检查VPC ID是否正确。
    400AccountMoneyValidateErrorAccount money validate error.-
    400RequestTokenConflictSpecified request token conflict.-
    400InvalidIPNotInSubnetError ip not in subnet.-
    400InvalidEngineVersion.MalformedSpecified engine version is not valid.无效的引擎版本
    400Zone.ClosedThe specified zone is closed.-
    400VSwithNotBelongToNotVpcFaultThe vSwitch does not belong to current vpc.-
    400PayIllegalAgreementPay mayi with holding agreement illegal.-
    400IllegalParamErrorvalidateSaleConditionWithSubArticle failed.-
    400CASH_BOOK_INSUFFICIENTNo payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.-
    400InvalidRegion.FormatSpecified Region is not valid.-
    400DryRunOperationRequest validation has been passed with DryRun flag set.-
    400ResourceGroupNotExistThe Specified ResourceGroupId does not exist.-
    403RealNameAuthenticationErrorYour account has not passed the real-name authentication yet.您的帐户还没有通过实名认证。
    403AuthorizationFailureThe request processing has failed due to authorization failure.-
    403TokenServiceErrorThe specified token is duplicated, please change it.-
    404InvalidvSwitchIdThe Specified vSwitchId zone not supported.-
    404InvalidVpcIdOrVswitchId.NotSupportedThe Specified vpcId or vSwitchId not supported.-

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

    变更历史

    变更时间变更内容概要操作
    2024-05-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:RecoverConfigMode
    2024-05-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:SlaveReadOnlyCount
    2024-01-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2023-09-05OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2023-08-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ParamGroupId
    2023-08-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:NodeType
    2023-06-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ConnectionStringPrefix
    2023-04-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:Appendonly
    2023-04-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:GlobalSecurityGroupIds
    2022-06-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2022-03-01OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2022-03-01OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ShardCount
    2022-02-22OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404