All Products
Search
Document Center

Tair:CreateTairInstance

Last Updated:Apr 10, 2024

Creates a Tair instance.

Operation description

For information about instance selection, see Select an ApsaraDB for Redis instance.

Before you call this operation, make sure that you are familiar with the billing methods and pricing of ApsaraDB for Redis.

  • For information about how to create a Tair instance in the Tair console, see Create a Tair instance.
  • If you want to create other types of instances, such as Community Edition instances or Tair DRAM-based instances, you can call the CreateInstance operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:CreateTairInstanceWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/*
  • kvstore:InstanceClass
  • kvstore:InstanceType
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where you want to create the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceNamestringNo

The name of the instance. The name must meet the following requirements:

  • The name is 2 to 80 characters in length.
  • The name starts with a letter and does not contain spaces or special characters. Special characters include @ / : = " < > { [ ] }
apitest
PasswordstringNo

The password that is used to connect to the instance. The password must meet the following requirements:

  • The password is 8 to 32 characters in length.
  • The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =
Pass!123456
InstanceClassstringYes

The instance type. For more information, see the following topics:

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

The primary zone ID of the instance. You can call the DescribeRegions operation to query the IDs of available zones.

Note You can also set the SecondaryZoneId parameter to specify the secondary zone. The primary and secondary nodes will then be deployed in the specified primary and secondary zones to implement the master-replica zone-disaster recovery architecture. For example, you can set the ZoneId parameter to cn-hangzhou-h and the SecondaryZoneId parameter to cn-hangzhou-g.
cn-hangzhou-e
ChargeTypestringNo

The billing method of the instance. Default value: PrePaid. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
PrePaid
VpcIdstringYes

The ID of the virtual private cloud (VPC). You can call the DescribeVpcs operation to query the ID of the VPC.

vpc-bp1nme44gek34slfc****
VSwitchIdstringYes

The ID of the vSwitch that belongs to the VPC. You can call the DescribeVpcs operation to query the ID of the vSwitch.

vsw-bp1e7clcw529l773d****
PeriodintegerNo

The subscription duration. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, and 60. Unit: months.

Note This parameter is required only if you set the ChargeType parameter to PrePaid.
1
BusinessInfostringNo

The ID of the promotion event or the business information.

000000000
CouponNostringNo

The coupon code.

youhuiquan_promotion_option_id_for_blank
SrcDBInstanceIdstringNo

The ID of the source instance.

Note If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance and the BackupId parameter to the backup set that you want to use.
r-bp1zxszhcgatnx****
BackupIdstringNo

The ID of the backup set of the source instance. If you want to create an instance based on a backup set of a specified instance, you can specify this parameter after you specify the SrcDBInstanceId parameter. Then, the system creates an instance based on the backup set that is specified by this parameter. You can call the DescribeBackups operation to query the IDs of backup sets.

Note If you want to create an instance based on a backup set of a specified instance, you must specify this parameter after you use the SrcDBInstanceId parameter to specify the ID of the source instance. Then, the system creates an instance based on the backup set that is specified by this parameter.
11111111
ClusterBackupIdstringNo

This parameter is supported for specific new cluster instances. You can query the backup set ID by using the DescribeClusterBackupList operation.

  • If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the BackupId parameter.
  • If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,). Example: "11101,11102".
cb-hyxdof5x9kqb****
PrivateIpAddressstringNo

The private IP address of the instance.

Note The IP address must be within the CIDR block of the vSwitch to which you want the instance to connect. You can call the DescribeVSwitches operation of the VPC API to query the CIDR block information.
172.16.88.***
AutoUseCouponstringNo

Specifies whether to use a coupon. Default value: false. Valid values:

  • true: uses a coupon.
  • false: does not use a coupon.
true
AutoRenewstringNo

Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal.
true
AutoRenewPeriodstringNo

The subscription duration that is supported by auto-renewal. Unit: months. Valid values: 1, 2, 3, 6, and 12.

Note This parameter is required only if the AutoRenew parameter is set to true.
3
ResourceGroupIdstringNo

The ID of the resource group to which you want to assign the instance.

Note
rg-acfmyiu4ekp****
AutoPaybooleanNo

Specifies whether to enable automatic payment. Set the value to true.

true
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz****
StorageTypestringNo

The storage type of the instance. Set the value to essd_pl1.

Note This parameter is available only if the InstanceType parameter is set to tair_essd.
Enumeration Value:
  • essd_pl0
  • essd_pl1
  • essd_pl2
  • essd_pl3
essd_pl1
StorageintegerNo

The storage space of cloud disks. Valid values vary based on the instance specifications. For more information, see ESSD-based instances.

Note This parameter is available and required only if the InstanceType parameter is set to tair_essd.
60
ShardTypestringNo

The data shard type of the instance. Default value: MASTER_SLAVE. Valid values:

  • MASTER_SLAVE: runs in a master-replica architecture that provides high availability.
  • STAND_ALONE: runs in a standalone architecture. If the only node fails, the system creates a new instance and switches the workloads to the new instance. This may cause data loss. You can set this parameter to this value only if the instance uses the single-zone deployment type. If you set this parameter to this value, you cannot create cluster or read/write splitting instances.
MASTER_SLAVE
ShardCountintegerNo

The number of data nodes in the instance. Valid values:

  • 1: You can create an instance in the standard architecture that contains only one data node. For more information about the standard architecture, see Cluster master-replica instances. This is the default value.
  • 2 to 32: You can create an instance in the cluster architecture that contains the specified number of data nodes. For more information about the cluster architecture, see Cluster master-replica instances.
Note Only persistent memory-optimized instances can use the cluster architecture. Therefore, you can set this parameter to an integer from 2 to 32 only if you set the InstanceType parameter to tair_scm.
1
ReadOnlyCountintegerNo

The number of read-only nodes of the instance. This parameter is available only if you create a read/write splitting instance that uses cloud disks. You can use this parameter to specify a custom number of read-only nodes for the instance. Valid value: 1 to 5.

5
EngineVersionstringNo

The engine version. Default value: 1.0. The parameter value varies with the Tair instance type.

  • For Tair DRAM-based instances (tair_rdb) that are compatible with Redis 5.0 or 6.0, set this parameter to 5.0 or 6.0.
  • For Tair persistent memory-optimized instances (tair_scm) that are compatible with Redis 6.0, set this parameter to 1.0.
  • For Tair ESSD-based instances (tair_essd) that are compatible with Redis 4.0 or 6.0, set this parameter to 1.0 or 2.0.
1.0
InstanceTypestringYes

The storage type of the instance. Valid values:

  • tair_rdb: ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance
  • tair_scm: ApsaraDB for Redis Enhanced Edition (Tair) persistent memory-optimized instance
  • tair_essd: ApsaraDB for Redis Enhanced Edition (Tair) ESSD-based instance
tair_scm
SecondaryZoneIdstringNo

The ID of the secondary zone. You can call the DescribeRegions operation to query the ID of the secondary zone.

Note You cannot specify multiple zone IDs or set this parameter to a value that is the same as that of the ZoneId parameter.
cn-hangzhou-h
GlobalInstanceIdstringNo

The ID of the distributed instance.

gr-bp14rkqrhac****
Tagobject []No

The tags to add to the instance.

KeystringNo

The key of the tag. A tag is a key-value pair.

Note A maximum of five key-value pairs can be specified at a time.
key1_test
ValuestringNo

The value of the tag.

Note N specifies the serial number of the tag. For example, Tag.1.Value specifies the value of the first tag, and Tag.2.Value specifies the value of the second tag.
value1_test
DryRunbooleanNo

Specifies whether to perform a dry run. Default value: false. Valid values:

  • true: performs a dry run and does not create the instance. The system prechecks the request parameters, request format, service limits, and available resources. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false: performs a dry run and sends the request. If the request passes the dry run, the instance is created.
false
PortintegerNo

The port number of the instance. Valid values: 1024 to 65535. Default value: 6379.

6379
GlobalSecurityGroupIdsstringNo

The global IP whitelist template of the instance. Separate multiple IP whitelist templates with commas (,) and make sure that each IP whitelist template is unique.

g-zsldxfiwjmti0kcm****
ParamGroupIdstringNo

The ID of the parameter template. The instance is created based on the parameters in the parameter template. The ID must be unique.

g-50npzjcqb1ua6q6j****
SlaveReadOnlyCountintegerNo

The number of read replicas in the secondary zone. This parameter is used to create a read/write splitting instance that is deployed across multiple zones.

Note To create a read/write splitting instance that is deployed across multiple zones, you must specify both SlaveReadOnlyCount and SecondaryZoneId.
1

Response parameters

ParameterTypeDescriptionExample
object

The object.

QPSlong

The maximum number of read and write operations that can be processed by the instance per second. The value is a theoretical value.

100000
ConnectionDomainstring

The internal endpoint of the instance.

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

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
PrePaid
InstanceIdstring

The ID of the instance.

r-bp13ac3d047b****
Portinteger

The port number that is used to connect to the instance.

6379
Configstring

The detailed configurations of the instance. The value is a JSON string. For more information about the parameter description, see Modify the parameters of an ApsaraDB for Redis instance.

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

The region ID of the instance.

cn-hangzhou
RequestIdstring

The ID of the request.

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

The maximum bandwidth of the instance. Unit: MB/s.

96
Connectionslong

The maximum number of connections supported by the instance.

10000
InstanceNamestring

The name of the instance.

**

This parameter is returned only if the InstanceName parameter is specified in the request.

redistest
ZoneIdstring

The zone ID of the instance.

cn-hangzhou-h
InstanceStatusstring

The state of the instance. The return value is Creating.

Creating
TaskIdstring

The ID of the task.

10****
OrderIdlong

The ID of the order.

2084452111111

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
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.Your account balance is insufficient. Add funds to your account and try again.
400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.The maximum number of instances has been reached.
400InvalidCapacity.NotFoundThe Capacity provided does not exist in our records.The specified instance capacity is invalid.
400ResourceNotAvailableResource you requested is not available for finance user.The requested resource is unavailable to users of Alibaba Finance Cloud.
400PaymentMethodNotFoundNo payment method has been registered on the account.No payment methods are specified for your account.
400IdempotentParameterMismatchRequest uses a client token in a previous request but is not identical to that request.The current request uses a token that was already used in a different request.
400QuotaNotEnoughQuota not enough in this zone.The number of instances specified for this region is insufficient.
400QuotaExceedLiving afterpay instances quota exceed.The maximum number of instances has been reached.
400VpcServiceErrorInvoke vpc service failed.-
400IzNotSupportVpcErrorSpecify iz not support vpc.The specified iz does not support VPCs.
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.The specified VPC is not found. Check whether the VPC ID is correct.
400AccountMoneyValidateErrorAccount money validate error.-
400RequestTokenConflictSpecified request token conflict.-
400InvalidIPNotInSubnetError ip not in subnet.-
400InvalidEngineVersion.MalformedSpecified engine version is not valid.The error message returned because the instance engine version is invalid.
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.Your account has not completed real-name verification.
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.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-29The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: SlaveReadOnlyCount
2024-01-12The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ClusterBackupId
2024-01-03The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2023-12-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2023-09-14API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2023-07-25The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ParamGroupId
2023-06-21The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: ParamGroupId
2023-06-21The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ParamGroupId
2023-04-03The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: GlobalSecurityGroupIds
2022-11-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2022-07-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2022-06-15The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.