Tair (Redis® OSS-Compatible):CreateInstance

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.

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.

The name of the instance. The name must be 2 to 80 characters in length and must start with a letter. It cannot contain spaces or specific special characters. These special characters include @ / : = " < > { [ ] }

The password that is used to connect to the instance. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters. These special characters include ! @ # $ % ^ & * ( ) _ + - =

The storage capacity of the instance. Unit: MB.

The instance type. For example, redis.master.small.default indicates a Community Edition standard master-replica instance that has 1 GB of memory. For more information, see Overview .

**

Description You must specify at least one of the Capacity and InstanceClass parameters when you call the CreateInstance operation.

The primary zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list.

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

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

The node type. Valid values:

• MASTER_SLAVE: high availability (master-replica)
• STAND_ALONE: standalone
• double: master-replica
• single: standalone

The network type of the instance. Default value: VPC. Valid values:

• VPC

The ID of the virtual private cloud (VPC).

The ID of the vSwitch to which you want the instance to connect.

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

The ID of the promotional event or business information.

The coupon code. Default value: default.

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.

If your instance is a cloud-native cluster instance, we recommend that you use DescribeClusterBackupList to query the backup set ID of the cluster instance, such as cb-xx. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.

You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the DescribeBackups operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,). Example: "10**,11**,15**".

The category of the instance. Default value: Redis. Valid values:

• Redis
• Memcache

The engine version. Valid values for classic instances:

• 2.8 (not recommended due to scheduled EOFS)
• 4.0 (not recommended)
• 5.0

Valid values for cloud-native instances:

• 5.0
• 6.0 (recommended)
• 7.0

The private IP address of the instance.

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

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

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

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

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

The ID of the resource group.

If data flashback is enabled for the source instance, you can use this parameter to specify a point in time within the backup retention period of the source instance. The system uses the backup data of the source instance at the point in time to create an instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The ID of the dedicated cluster. This parameter is required if you create an instance in a dedicated cluster.

The number of data shards. This parameter is available only if you create a cluster instance that uses cloud disks.

The number of read replicas in the primary zone. This parameter applies only to read/write splitting instances that use cloud disks. You can use this parameter to customize the number of read replicas. Valid values: 1 to 9.

The ID of the distributed instance. This parameter is available only on the China site (aliyun.com).

Specifies whether to use the new instance as the first child instance of the distributed instance. Default value: false. Valid values:

• true: uses the new instance as the first child instance.

• false: does not use the new instance as the first child instance.

• If you want to create an ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance that runs Redis 5.0, you must set this parameter to true.

• This parameter is available only on the China site (aliyun.com).

The secondary zone ID of the instance. You can call the DescribeZones operation to query the most recent zone list.

The port number that is used to connect to the instance. Valid values: 1024 to 65535. Default value: 6379.

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 message 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.

The global IP whitelist template for the instance. Multiple IP whitelist templates should be separated by English commas (,) and cannot be duplicated.

Specifies whether to enable append-only file (AOF) persistence for the instance. Valid values:

• yes (default): enables AOF persistence.
• no: disables AOF persistence.

**

Description This parameter is applicable to classic instances, and is unavailable for cloud-native instances.

The operation that you want to perform. Set the value to AllocateInstancePublicConnection.

The parameter template ID, which must be globally unique.

The tags of the instance.

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 for all shards of the source instance, separated by commas (,). Example: "2158****20,2158****22".

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. The sum of the values of this parameter and ReadOnlyCount cannot be greater than 9.