ApsaraDB for Redis:CreateTairInstance

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 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 @ / : = " < > { [ ] }

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 ! @ # $ % ^ & * ( ) _ + - =

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

• DRAM-based instances
• Persistent memory-optimized instances
• ESSD-based instances

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

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

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

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

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

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 promotion event or the business information.

The coupon code.

The ID of the source instance.

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.

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

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 to which you want to assign the instance.

• You can query resource group IDs by using the ApsaraDB for Redis console or by calling the ListResourceGroups operation. For more information, see View basic information of a resource group.

• Before you modify the resource group to which an instance belongs, you can call the ListResources operation to view the current resource group of the instance.

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

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 storage type of the instance. Set the value to essd_pl1.

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

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.

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.

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.

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.

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

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

The ID of the distributed instance.

The tags to add to the instance.

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.

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

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.

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

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.