CreateTairInstance - 创建Tair实例

更新时间: 2023-11-03 10:20:23

创建Tair版实例。

接口说明

选型参考资料,请参见阿里云Redis产品选型必读

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

说明
  • 关于控制台的操作方法,请参见创建Tair实例
  • 如需创建其他类型的实例,例如社区版或Tair内存型经典版实例,您可以调用CreateInstance接口。
  • 调试

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

    调试

    授权信息

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

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

    请求参数

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

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

    cn-hangzhou
    InstanceNamestring

    实例名称,需满足下述要求:

    • 长度为2~80个字符。
    • 以大小写英文字母或中文开头,不支持空格和特殊字符:@/:=”<>{[]}
    apitest
    Passwordstring

    实例密码,需满足下述要求:

    • 长度为8~32位。
    • 需包含大写字母、小写字母、特殊字符和数字中的至少三种,支持的特殊字符为!@#$%^&*()_+-=
    Pass!123456
    InstanceClassstring

    实例规格,更多信息,请参见:

    tair.scm.standard.4m.32d
    ZoneIdstring

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

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

    付费类型,取值:

    • PrePaid(默认):预付费,即包年包月。
    • PostPaid:按量付费。
    PrePaid
    VpcIdstring

    专有网络ID,可调用专有网络VPC的DescribeVpcs获取。

    vpc-bp1nme44gek34slfc****
    VSwitchIdstring

    该专有网络下的虚拟交换机ID,可调用专有网络VPC的DescribeVpcs获取。

    vsw-bp1e7clcw529l773d****
    Periodinteger

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

    说明 ChargeType取值为PrePaid时,本参数必须传入。
    1
    BusinessInfostring

    活动ID、业务信息。

    000000000
    CouponNostring

    优惠码。

    youhuiquan_promotion_option_id_for_blank
    SrcDBInstanceIdstring

    源实例ID。

    说明 如需基于某个实例的备份集创建新实例,请先在此参数中指定源实例ID,然后通过BackupId参数指定需要使用的备份集。
    r-bp1zxszhcgatnx****
    BackupIdstring

    源实例的备份集ID,可调用DescribeBackups获取。

    说明 如需基于某个实例的备份数据创建新实例,在通过SrcDBInstanceId指定源实例ID后,您还需传入本参数指定源实例的备份集ID,系统将使用该备份集中保存的数据创建新实例。
    11111111
    PrivateIpAddressstring

    指定实例的内网IP地址。

    说明 该地址需在实例所属交换机的网段内,您可以调用专有网络VPC的DescribeVSwitches获取网段信息。
    172.16.88.***
    AutoUseCouponstring

    是否使用代金券,取值:

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

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

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

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

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

    目标资源组ID。

    说明
  • 您可以通过调用ListResourceGroups接口或通过控制台获取资源组ID列表。相关操作,请参见查看资源组基本信息
  • 修改实例所属的资源组之前,您可以调用ListResources接口查看实例现在所属的资源组。
  • rg-acfmyiu4ekp****
    AutoPayboolean

    自动支付,取值固定为true

    true
    ClientTokenstring

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

    ETnLKlblzczshOTUbOCz****
    StorageTypestring

    存储类型,取值固定为essd_pl1

    说明 InstanceType取值为tair_essd时,本参数才可用。
    essd_pl1
    Storageinteger

    云盘的存储空间,不同的规格取值范围有所区别,详情请参见云盘(ESSD)型规格

    说明 InstanceType取值为tair_essd时,本参数才可用且必须传入。
    60
    ShardTypestring

    实例类型,取值:

    • MASTER_SLAVE(默认):高可用,采用主从架构,可保障可用性。
    • STAND_ALONE:单副本,采用单节点架构。在节点故障后,数据会丢失,系统会自动拉起新的空实例。仅在单可用区时支持,且不支持创建集群与读写分离架构。
    MASTER_SLAVE
    ShardCountinteger

    实例中的数据节点个数,取值:

    • 1:默认值,即表示创建的实例为标准架构,仅拥有1个数据节点。
    • 2~32:传入该范围的值,即表示创建的实例为集群架构,拥有指定数量的数据节点。
    说明 InstanceType取值为tair_rdbtair_scm时,本参数才可以传入2~32,即只有内存型和持久内存型支持集群架构。
    1
    ReadOnlyCountinteger

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

    5
    EngineVersionstring

    数据库版本,默认取值:1.0(自研,兼容Redis 5.0)。

    1.0
    InstanceTypestring

    存储介质,取值:

    • tair_rdb:内存型。
    • tair_scm:持久内存型。
    • tair_essd:云盘(ESSD)型。
    tair_scm
    SecondaryZoneIdstring

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

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

    分布式实例ID。

    gr-bp14rkqrhac****
    Tagobject []

    实例的标签信息。

    Keystring

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

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

    标签的值。

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

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

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

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

    6379
    GlobalSecurityGroupIdsstring

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

    g-zsldxfiwjmti0kcm****
    ParamGroupIdstring

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

    g-50npzjcqb1ua6q6j****

    返回参数

    名称类型描述示例值
    object

    对象。

    QPSlong

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

    100000
    ConnectionDomainstring

    实例的内网连接地址。

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

    实例的付费类型,返回值:

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

    实例ID。

    r-bp13ac3d047b****
    Portinteger

    实例的端口号。

    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****
    Bandwidthlong

    实例的最大带宽,单位:MB/s。

    96
    Connectionslong

    实例的最大连接数。

    10000
    InstanceNamestring

    实例名称。

    说明 当传入了请求参数InstanceName时,本参数才会返回。
    redistest
    ZoneIdstring

    可用区ID。

    cn-hangzhou-h
    InstanceStatusstring

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

    Creating
    TaskIdstring

    任务ID。

    10****
    OrderIdlong

    订单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错误码错误信息描述
    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.-
    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.-
    403UserCannotBuyNotInnerCommodityThe user can not buy this commodity without alibaba group tag.-
    404InvalidvSwitchIdThe Specified vSwitchId zone not supported.-
    404InvalidVpcIdOrVswitchId.NotSupportedThe Specified vpcId or vSwitchId not supported.-

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

    变更历史

    变更时间变更内容概要操作
    2023-09-14OpenAPI 描述信息更新,OpenAPI 错误码发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2023-07-25OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ParamGroupId
    2023-06-21OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      删除入参:ParamGroupId
    2023-06-21OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ParamGroupId
    2023-04-03OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:GlobalSecurityGroupIds
    2022-11-14OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2022-07-27OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2022-06-15OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    阿里云首页 云数据库 Redis 相关技术圈