Tair (Redis® OSS-Compatible):CreateTairInstance

The region ID. 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 must be 2 to 80 characters in length.
• The name must start with a letter and cannot 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 must be 8 to 32 characters in length.
• The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - =

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

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

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

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

The billing method of the instance. Valid values:

• PrePaid (default): subscription
• PostPaid: pay-as-you-go

The ID of the VPC. You can call the DescribeVpcs operation to query VPC IDs.

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

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

The ID of the promotional event or the business information.

The coupon code.

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.

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 the backup set ID. 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**".

This parameter is supported for specific new cluster instances. You can query the backup set ID by calling 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: "2158****20,2158****22".

Specifies whether to restore the account, kernel parameter, and whitelist information from the original backup set when you create an instance from the specified backup set. For example, if you want to restore the account information, set the parameter to {"account":true}.

This parameter is empty by default, which indicates that the account, kernel parameter, and whitelist information is not restored from the original backup set.

The internal IP address of the instance.

Specifies whether to use a coupon. Valid values:

• true: uses a coupon.
• false (default): does not use a coupon.

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

• true: enables auto-renewal.
• false (default): disables auto-renewal.

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

The ID of the resource group that you want to manage.

• You can query resource group IDs in the console or by calling the ListResourceGroups operation. For more information, see View the basic information about 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 token, but you must make sure that the token is unique among different requests and is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.

The storage type. Valid values: essd_pl1, essd_pl2, and essd_pl3.

Enumerated values:

• essd_pl0
• essd_pl1
• essd_pl2
• essd_pl3

The storage capacity of the ESSD/SSD-based instance. The valid values vary based on the instance type. For more information, see ESSD/SSD-based instances.

The shard type of the instance. Valid values:

• MASTER_SLAVE (default): 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 the ShardType parameter to this value only if the instance uses the single-zone deployment mode. If you set the ShardType parameter to this value, you cannot create cluster or read/write splitting instances.

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

• 1 (default): You can create a standard instance that contains only one data node.
• 2 to 32: You can create a cluster instance that contains the specified number of data nodes.

The number of replica nodes in the primary zone. This parameter applies only to cloud-native multi-replica cluster instances. Valid values: 1 to 4.

• The sum of the values of this parameter and the SlaveReplicaCount parameter cannot exceed 4.

• You can specify only one of the ReplicaCount and ReadOnlyCount parameters.

• Master-replica instances do not support multiple replicas.

The number of replica nodes in the secondary zone when you create a cloud-native multi-replica cluster instance deployed across multiple zones. The sum of the values of this parameter and the ReplicaCount parameter cannot exceed 4.

The number of read replicas in the primary zone. This parameter applies only to cloud-native read/write splitting instances. Valid values: 1 to 9.

The number of read replicas in the secondary zone when you create a multi-zone read/write splitting instance. The sum of the values of this parameter and the ReadOnlyCount parameter cannot exceed 9.

The database engine version. Default value: 1.0. The parameter value varies based on the Tair instance series.

• To create a Tair DRAM-based instance (Tair_rdb) that is compatible with Redis 5.0, 6.0, or 7.0, set this parameter to 5.0, 6.0, or 7.0.
• To create a Tair persistent memory-optimized instance (tair_scm) that is compatible with Redis 6.0, set this parameter to 1.0.
• To create a Tair ESSD-based instance (tair_essd) that is compatible with Redis 6.0, set this parameter to 1.0. To create a Tair SSD-based instance that is compatible with Redis 6.0, set this parameter to 2.0.

The instance series. Valid values:

• tair_rdb: Tair DRAM-based instance
• tair_scm: Tair persistent memory-optimized instance
• tair_essd: Tair ESSD/SSD-based instance

Specifies whether to use the created instance as a child instance of a distributed instance.

• If you want the created instance to be used as the first child instance, enter true.
• If you want the created instance to be used as the second or third child instance, enter the ID of the distributed instance, such as gr-bp14rkqrhac****.
• If you do not want the created instance to be used as a distributed instance, leave the parameter empty.

Details of the tags.

Specifies whether to perform only a dry run, without performing the actual request. 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 precheck, the DryRunOperation error code is returned.
• false (false): performs a dry run and performs the actual request. If the request passes the dry run, the instance is directly created.

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

The global IP whitelist templates of the instance. Separate multiple IP whitelist templates with commas (,). Each IP whitelist template must be unique.

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

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 prefix of the endpoint. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start with a lowercase letter.