RunInstances

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

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

The ID of the image used to create the instances. You can call the DescribeImages operation to query the available images. If you do not use the LaunchTemplateId or LaunchTemplateName parameter to specify an instance launch template, or do not use the ImageFamily parameter to select the latest available custom image, you must specify the ImageId parameter.

The name of the image family. You can set this parameter to obtain the latest available custom image within the specified image family to create ECS instances.

• If you set the ImageId parameter, you cannot set the ImageFamily parameter.
• If you do not set the ImageId parameter, but you set the ImageId parameter in the launch template specified by the LaunchTemplateId or LaunchTemplateName parameter, you cannot set the ImageFamily parameter.
• If you do not set the ImageId parameter, and do not set the ImageId parameter in the launch template specified by the LaunchTemplateId or LaunchTemplateName parameter, you can set the ImageFamily parameter.
• If you do not set the ImageId parameter, or do not set the LaunchTemplateId or LaunchTemplateName parameter, you can set the ImageFamily parameter.

The instance type of the instance. If you do not set LaunchTemplateId or LaunchTemplateName to specify a launch template, you must specify the InstanceType parameter.

• Select instance types: See Instance families or call the DescribeInstanceTypes operation to query the performance data of the instance types to which the instances to be created belong, or see Select instance types to learn how to select instance types.
  • Query available resources: Call the DescribeAvailableResource operation to query available resources in a specific region or zone.

The ID of the security group to which to assign the instance. Instances in the same security group can communicate with each other. The number of instances that a security group can contain depends on the type of the security group. For more information, see the "Security group limits" section of the Limits topic.

If you do not use the LaunchTemplateId or LaunchTemplateName parameter to specify the instance launch template, you must set the SecurityGroupId parameter.

The ID of security group N to which to assign the instance. Valid values of N are based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section of the Limits topic.

The ID of the vSwitch. You must specify this parameter when you create a VPC-type instance. The vSwitch and security group must belong to the same VPC.

The name of the instance. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). It must start with a letter and cannot start with http:// or https://. The default value of this parameter is the InstanceId value.

If you do not append suffixes to the instance names or hostnames by using the name_suffix format, but only use the name_prefix[begin_number,bits] format, the UniqueSuffix parameter is ignored. For example, when you set InstanceName to instance-[99,3] and UniqueSuffix to true, the instance name is instance099 instead of instance099001.

The description of the instance. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:

• If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, valid values of this parameter are 1 to 10 and the default value of this parameter is 10.
• If the purchased outbound public bandwidth is greater than 10 Mbit/s, valid values of this parameter are 1 to the value of the InternetMaxBandwidthOut parameter and the default value is the value of the InternetMaxBandwidthOut parameter.

The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.

Default value: 0.

The hostname of the instance.

• The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).
• For Windows instances, the hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.) or only contain digits.
• For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

If you do not append suffixes to the instance names or hostnames by using the name_suffix format, but only use the name_prefix[begin_number,bits] format, the UniqueSuffix parameter is ignored. For example, when you set InstanceName to instance-[99,3] and UniqueSuffix to true, the instance name is instance099 instead of instance099001.

Specifies whether to append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter. The sequential suffixes range from 001 to 999. For example, the hostnames can be LocalHost001 and LocalHost002. The instance names can be MyInstance001 and MyInstance002. Valid values:

• true
• false

Default value: false.

The password of the instance. The password must be 8 to 30 characters in length. It must include at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include

( ) ` ~ ! @ # $ % ^ & * - _ + = | { } [ ] : ; ' < > , . ? /
                                

For Windows instances, the password cannot start with a forward slash (/).

Specifies whether to use the password preset in the image. Valid values:

• true
• false

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

If you do not specify a zone ID, the system randomly selects a zone.

The billing method for network usage. Default value: PayByTraffic. Valid values:

• PayByBandwidth
• PayByTraffic

The size of the system disk. Unit: GiB. Valid values: 20 to 500.

The value of this parameter must be at least 20 and greater than or equal to the size of the image.

The default value is 40 or the size of the image, depending on whichever is greater.

The category of the system disk. Valid values:

• cloud_efficiency: ultra disk
• cloud_ssd: standard SSD
• cloud_essd: enhanced SSD (ESSD)
• cloud: basic disk

For non-I/O optimized instances of retired instance types, the default value is cloud. For other instances, the default value is cloud_efficiency.

The name of the system disk. The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

This parameter is empty by default.

The description of the system disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

The performance level of the ESSD used as the system disk. Default value: PL0. Valid values:

• PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
• PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
• PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
• PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSD.

The ID of the automatic snapshot policy to be applied to the system disk.

The size of data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:

• Valid values when DataDisk.N.Category is set to cloud_efficiency: 20 to 32768
• Valid values when DataDisk.N.Category is set to cloud_ssd: 20 to 32768
• Valid values when DataDisk.N.Category is set to cloud_essd: 20 to 32768
• Valid values when DataDisk.N.Category is set to ephemeral_ssd: 5 to 800
• Valid values when DataDisk.N.Category is set to cloud: 5 to 2000

The value of this parameter must be greater than or equal to the size of the snapshot specified by the SnapshotId parameter.

The ID of the snapshot used to create data disk N. Valid values of N: 1 to 16.

When the DataDisk.N.SnapshotId parameter is specified, the DataDisk.N.Size parameter is ignored. The data disk is created based on the size of the specified snapshot. Use snapshots created after July 15, 2013. Otherwise, an error message is returned and your request is rejected.

The category of data disk N. Valid values:

• cloud_efficiency: ultra disk
• cloud_ssd: standard SSD
• ephemeral_ssd: local SSD
• cloud_essd: ESSD
• cloud: basic disk

For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud.

Specifies whether to encrypt data disk N. Valid values:

• true: specifies to encrypt the disk.
• false: specifies to not encrypt the disk.

Default value: false.

The ID of the KMS key to be used by data disk N.

The name of data disk N. The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

This parameter is empty by default.

The description of data disk N. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

The mount point of data disk N.

Specifies whether to release data disk N when the instance is released. Valid values:

• true: specifies to release data disk N together with the instance.
• false: specifies to not release data disk N together with the instance.

Default value: true.

The performance level of the ESSD used as data disk N. The N value must be the same as that in DataDisk.N.Category when DataDisk.N.Category is set to cloud_essd. Default value: PL1. Valid values:

• PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
• PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
• PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
• PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSD.

The ID of the automatic snapshot policy to be applied to data disk N.

Specifies whether the instance is I/O optimized. For instances of retired instance types, the default value is none. For other instances, the default value is optimized. For more information, see Retired instance types. Valid values:

• none: The instance is not I/O optimized.
• optimized: The instance is I/O optimized.

The primary IP address of secondary elastic network interface (ENI) N. Set the value of N to 1.

The default value is an IP address that is randomly selected from within the CIDR block of the vSwitch to which the secondary ENI is connected.

The ID of the vSwitch to which secondary ENI N is connected. Set the value of N to 1.

The default value is the ID of the vSwitch to which to connect the instance.

The ID of the security group to which secondary ENI N belongs. Set the value of N to 1.

The default value is the ID of the security group to which to assign the instance.

The ID of security group N to which the secondary ENI belongs. The valid values of N in SecurityGroupIds.N are based on the maximum number of security groups to which the instance equipped with the ENI can belong. For more information, see Limits.

The name of secondary ENI N. Set the value of N to 1.

The description of secondary ENI N. Set the value of N to 1. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

The number of queues supported by secondary ENI N. Set the value of N to 1.

• The value of this parameter cannot exceed the maximum number of queues per ENI allowed for the instance type.
• The total number of queues for all ENIs bound to the instance cannot exceed the queue quota allowed for the instance type. To learn the maximum number of queues per ENI and the queue quota allowed for an instance type, you can call the DescribeInstanceTypes operation to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity fields.

The user data of the instance. User data must be encoded in Base64. The maximum size of raw data is 16 KB.

The name of the key pair to be bound to the instance.

• For Windows instances, this parameter is ignored and is empty by default. The Password parameter takes effect even if the KeyPairName parameter is specified.
• For Linux instances, the username and password authentication method is disabled by default.

The instance RAM role. You can call the ListRoles operation provided by RAM to query the RAM roles that you have created.

The number of instances that you want to create. Valid values: 1 to 100.

Default value: 1.

The minimum number of instances that can be created. Valid values: 1 to 100.

• If the number of available ECS instances is less than the MinAmount value, the instance creation operation fails.
• If the number of available ECS instances is greater than or equal to the MinAmount value, the instance creation operation succeeds and the number of instances that are created equals the total number of available instances.

The automatic release time of the pay-as-you-go instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

• If the value of seconds (ss) is not 00, the start time is automatically rounded down to the current minute based on the value of mm.
• The release time must be at least 30 minutes later than the current time.
• The release time must be at most three years from the current time.

The preemption policy for a pay-as-you-go instance. This parameter takes effect only when the InstanceChargeType parameter is set to PostPaid. Default value: NoSpot. Valid values:

• NoSpot: applies to regular pay-as-you-go instances.
• SpotWithPriceLimit: applies to preemptible instances that have maximum hourly prices.
• SpotAsPriceGo: applies to pay-as-you-go instances that are of the market price at the time of purchase.

The retention period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.

• Protection periods of two to six hours are in invitational preview. If you want to set this parameter to one of these values, submit a ticket.
• If this parameter is set to 0, no protection period is configured for the preemptible instance.

Default value: 1.

The maximum hourly price of the instance. This parameter takes effect only when the SpotStrategy parameter is set to SpotWithPriceLimit. A maximum of three decimal places are allowed.

The interruption mode of the preemptible instance. Set the value to Terminate, which specifies to release the instance.

Specifies whether to enable security hardening. Valid values:

• Active: enables security hardening. This value is applicable only to public images.
• Deactive: disables security hardening. This value is applicable to all image types.

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 it is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

The key of tag N to be bound to the instance, disks, and primary ENI. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

The value of tag N to be bound to the instance, disks, and primary ENI. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length and cannot start with acs:. It cannot contain http:// or https://.

The ID of the E-HPC cluster to which to assign the instance.

Specifies whether to check the validity of the request without actually making the request. Default value: false. Valid values:

• true: The validity of the request is checked but the request is not made. Check items include the required parameters, request format, service limits, and available ECS resources. If the check fails, the corresponding error code is returned. If the check succeeds, the DryRunOperation error code is returned.
• false: The request is checked, and the instance is created if the check succeeds.

The ID of the dedicated host on which to create the instance. If the DedicatedHostId parameter is specified, the SpotStrategy and SpotPriceLimit parameters are ignored. This is because preemptible instances cannot be created on dedicated hosts.

You can call the DescribeDedicatedHosts operation to query the dedicated host list.

The ID of the launch template. For more information, see DescribeLaunchTemplates.

To use a launch template to create an instance, you must specify the launch template by using the LaunchTemplateId or LaunchTemplateName parameter.

The name of the launch template.

To use a launch template to create an instance, you must specify the launch template by using the LaunchTemplateId or LaunchTemplateName parameter.

The version of the launch template. If you specify LaunchTemplateId or LaunchTemplateName but do not specify the version number of the launch template, the default template version is used.

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

The subscription period of the instance. The unit is specified by the PeriodUnit parameter. This parameter is valid and required only when InstanceChargeType is set to PrePaid. If the DedicatedHostId parameter is specified, the subscription period of the instance cannot be longer than that of the dedicated host. Valid values:

• Valid values when PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.

The unit of the subscription period. Default value: Month. Valid values:

• Month

Specifies whether to enable auto-renewal for the instance. This parameter takes effect only when the InstanceChargeType parameter is set to PrePaid. Default value: false. Valid values:

• true: enables auto-renewal for the instance.
• false: disables auto-renewal for the instance.

The auto-renewal period of the instance. Valid values:

• Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60.

Default value: 1.

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

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

If you set this parameter to PrePaid, make sure that you have sufficient credit in your account. Otherwise, the InvalidPayMethod error is returned.

The ID of the deployment set.

The private IP address to be assigned to the instance.

To assign a private IP address to a VPC-type ECS instance, make sure that the IP address is an idle IP address within the CIDR block of the vSwitch specified by the VSwitchId parameter.

The performance mode of the burstable instance. Valid values:

• Standard: the standard mode. For more information, see the "Standard mode" section of the Burstable instances topic.
• Unlimited: the unlimited mode. For more information, see the "Unlimited mode" section of the Burstable instances topic.

This parameter is empty by default.

IPv6 address N to be assigned to the primary ENI. Set the value of N to 1. Example: Ipv6Address.1=2001:db8:1234:1a00::***.

The number of IPv6 addresses to be randomly generated for the primary ENI.

The number of queues supported by the primary ENI.

• The value of this parameter cannot exceed the maximum number of queues per ENI allowed for the instance type.
• The total number of queues for all ENIs bound to the instance cannot exceed the queue quota allowed for the instance type. To learn the maximum number of queues per ENI and the queue quota allowed for an instance type, you can call the DescribeInstanceTypes operation to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity fields.

The release protection property of the instance. It specifies whether you can use the ECS console or call the DeleteInstance operation to manually release the instance. Default value: false. Valid values:

• true: enables release protection.
• false: disables release protection.

Specifies whether an instance on a dedicated host is associated with the dedicated host. Valid values:

• default: The instance is not associated with the dedicated host. When the No Fees for Stopped Instances (VPC-Connected) feature is enabled and the instance is restarted, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if resources of the original dedicated host are insufficient.
• host: The instance is associated with the dedicated host. When the No Fees for Stopped Instances (VPC-Connected) feature is enabled and the instance is restarted, the instance still resides on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance fails to restart.

Default value: default.

Specifies whether to create the instance on a dedicated host. Valid values:

• default: creates the instance on a non-dedicated host.
• host: creates the instance on a dedicated host. If you do not specify the DedicatedHostId parameter, Alibaba Cloud automatically selects a dedicated host for the instance.

Default value: default.

The ID of the storage set.

The maximum number of partitions in the storage set. Valid values: greater than or equal to 2.

The number of CPU cores. This parameter cannot be specified but only uses its default value.

The number of threads per core. The following formula is used to calculate the number of vCPUs of the ECS instance: CpuOptions.Core value × CpuOptions.ThreadPerCore value.

• If the CpuOptions.ThreadPerCore parameter is set to 1, CPU hyper-threading is disabled.
• This parameter is applicable only to some instance types.

The number of CPU Numa nodes.

Specifies whether to enable the access channel for the instance metadata. Valid values:

• enabled
• disabled

Default value: enabled.

Specifies whether to forcibly use the security-enhanced mode (IMDSv2) to access instance metadata. Valid values:

• optional: The security-enhanced mode (IMDSv2) is not forcibly used.
• required: The security-enhanced mode (IMDSv2) is forcibly used. After you set this parameter to required, you cannot access the instance metadata in normal mode.

Default value: optional.

The type of the private pool. After an elasticity assurance or capacity reservation takes effect, a private pool is generated. You can select a private pool when you create an instance. Valid values:

• Open: The system automatically matches a private pool of the Open type for the instance to start up. If no matching private pools exist, the instance takes up capacity of public pool resources. If the parameter is set to Open, the PrivatePoolOptions.Id parameter must be empty.
• Target: The instance takes up capacity of a specific private pool to start up. If the specified private pool is unavailable, the instance fails to start up. If the parameter is set to Target, the PrivatePoolOptions.Id parameter must be specified.
• None: The instance does not take up capacity of a private pool to start up.

This parameter is empty by default.

The ID of the private pool. The value of this parameter indicates the ID of the elasticity assurance or capacity reservation that generates the private pool.

The IDs of the instances (InstanceIdSet).

The ID of the request.

The transaction price.