Tair: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 of the instance. Example: redis.master.small.default. A redis.master.small.default instance is a 1 GB standard master-replica instance of the Community Edition that uses local disks. For more information, see Overview.

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 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: youhuiquan_promotion_option_id_for_blank.

The ID of the original instance. If you want to create an instance based on a backup file of a specified instance, you can specify this parameter and use the BackupId or RestoreTime parameter to specify the backup file.

The ID of the backup file of the original instance. If you want to create an instance based on a backup file 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 file that is specified by this parameter. You can call the DescribeBackups operation to query the IDs of backup files.

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

• Redis
• Memcache

The database engine version of the instance. Valid values: 4.0, 5.0, 6.0, and 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.

The point in time at which the specified original instance is backed up. The point in time must be within the retention period of backup files of the original instance. If you want to create an instance based on a backup file of a specified instance, you can set this parameter to specify a point in time after you set the SrcDBInstanceId parameter. Then, the system creates an instance based on the backup file that was created at the specified point in time for the original 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. You can use this parameter to specify a custom number of data shards.

The number of read-only nodes in the instance. This parameter is available only if you create a read/write splitting instance that uses cloud disks. Valid values: 1 to 5.

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.

The tags of the instance.