RunInstances

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

The operation that you want to perform. Set the value to RunInstances. For HTTP and HTTPS requests, the Action parameter is required. Set this parameter to RunInstances.

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

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

The ID of the image to create the instance. You can call the DescribeImages operation to view the available image resources. If you do not specify LaunchTemplateId or LaunchTemplateName to set the launch template, you must specify the ImageId parameter.

The ID of the security group to which the instances belong. Instances in the same security group can communicate with each other. One security group can contain a maximum of 1,000 instances.

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

The ID of the VSwitch. It must be specified when you create VPC-connected instances.

The type of the instance. For more information, see Instance families or call the DescribeInstanceTypes operation to query the list of the latest instance types.

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

The maximum inbound bandwidth for Internet traffic. Unit: Mbit/s. Valid values: 1 to 200

Default value: 200

The maximum outbound bandwidth for Internet traffic. Unit: Mbit/s. Valid values: 0 to 100

Default value: 0

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

When you do not add suffixes name_suffix to the instance names or the hostnames, and instead 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 resulting instance name is instance099 instead of instance099001.

The hostname of the instance.

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

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

Specifies whether to add sequential suffixes to HostName and InstanceName. The sequential suffix ranges from 001 to 999. For example, the names can be LocalHost001, LocalHost002 and MyInstance001, MyInstance002. Default value: false

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

Specifies whether to use the password that is predefined in the image. If the PasswordInherit parameter is set to true, the Password parameter must not be specified. You must ensure that the selected image has a password configured.

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

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

Passwords for Windows instances cannot start with a forward slash (/).

The name of the key pair.

• For Windows instances, ignore this parameter. Default value: null The Password parameter is still used if the KeyPairName parameter is specified.
• For Linux instances, password authentication is disabled by default.

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

The parameter value must be a minimum of 20 and greater than or equal to the size of the image. Default value: 40 or the size of the image, depending on whichever is greater

The category of the system disk. The default value for retired instance types without I/O optimizations is cloud. The default value for other types of instances is cloud_efficiency. Valid values:

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

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

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

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

• cloud: 5 to 2,000
• cloud_efficiency: 20 to 32,768
• cloud_ssd: 20 to 32,768
• cloud_essd: 20 to 32,768
• ephemeral_ssd: 5 to 800

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

The ID of the snapshot used to create the Nth data disk. Valid values of N: 1 to 16 If the DataDisk.N.SnapshotId parameter is specified, the DataDisk.N.Size parameter is ignored, and the size of the created disk is the size of the specified snapshot. Snapshots created on or before July 15, 2013 are not applicable. Otherwise, an error will be returned and your request will be rejected.

The category of the Nth data disk. Valid values:

• cloud: basic disk. This is the default value.
• cloud_efficiency: ultra disk
• cloud_ssd: standard SSD
• ephemeral_ssd: local SSD
• cloud_essd: enhanced SSD (ESSD)

Specifies whether the Nth data disk is encrypted. Default value: false

The customer master key ID that is provided by Key Management Service (KMS) for the Nth data disk.

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

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

The mount point of the Nth data disk.

Specifies whether the Nth data disk is released along with the instance. Default value: true

Specifies whether the instance is an I/O optimized instance. The default value for retired instance types is none. The default value for other instances is optimized. Valid values:

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

The primary IP address of the secondary ENI. Valid values of N: 1

The default value is an IP address that is randomly selected from the VSwitch to which the ENI belongs.

The ID of the VSwitch to which the secondary ENI belongs. Valid values of N: 1

The default value is the VSwitch to which the ECS instance belongs.

The ID of the security group to which the secondary ENI belongs. Valid values of N: 1

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

The name of the secondary ENI. Valid values of N: 1

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

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

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

The minimum number of the specified instances to purchase. Valid values: 1 to 100

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

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

Default value: 1

The maximum hourly price for the preemptible instance. This parameter supports a maximum of three decimal places and takes effect when the SpotStrategy parameter is set to SpotWithPriceLimit.

The bidding mode of the pay-as-you-go instance. This parameter is valid when InstanceChargeType is set to PostPaid. Valid values:

• NoSpot: a standard pay-as-you-go instance. This is the default value.
• SpotWithPriceLimit: a preemptible instance with an upper price limit.
• SpotAsPriceGo: a preemptible instance that is billed based on the actual market price.

The interruption mode of the preemptible instance. Only the Terminate mode is supported. The instance is automatically released. This is the default value.

Specifies the performance mode of the t5 burstable instance. Valid values:

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

Default value: null

Specifies whether to enable security enhancement. Valid values:

• Active: enables security enhancement. It is only applicable to public images.
• Deactive: disables security enhancement for all image types.

The ID of the deployment set.

The ID of the dedicated host for the ECS instance. You can call the DescribeDedicatedHosts operation to view the dedicated host list.

No preemptible instance can be created on a dedicated host. Therefore, if you specify DedicatedHostId, the values of SpotStrategy and SpotPriceLimit is ignored.

The tag key of the instances, disks, and primary ENIs. Valid values of N: 1 to 20 It cannot be an empty string. It can be a maximum of 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.

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

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

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

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

You must specify either LaunchTemplateId or LaunchTemplateName to set a launch template.

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName to set a launch template.

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

Specifies whether you can use the ECS console or call the DeleteInstance operation to release the instances. Valid values:

• true: enables release protection.
• false: disables release protection. This is the default value.

The time when the instance is automatically released. The time follows the ISO 8601 standard in UTC+0. The format is yyyy-MM-ddTHH:mm:ssZ.

• If the value of the seconds field (ss) is not 00, the time will automatically be set to the start of the current minute (mm).
• It must be at least 30 minutes after the current time.
• The automatic release time must be less than 3 years from the current time.

The billing method of the network bandwidth. Valid values:

• PayByTraffic: The billing method is based on actual traffic. This is the default value.

The subscription period of the instance. Unit: Months. The values that are valid for this parameter depend on the value specified in the PeriodUnit parameter. This parameter is only valid and required when the InstanceChargeType parameter is set to PrePaid. If the DedicatedHostId parameter is specified, the specified period cannot exceed the subscription period of the dedicated host. Valid values:

• Week:1, 2, 3, and 4.
• Month:1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.

Specifies whether to enable automatic renewal. This parameter is valid when InstanceChargeType is set to PrePaid. Valid values:

• true: enables automatic renewal for the instance.
• false: disables automatic renewal for the instance. This is the default value.

The unit of the billing cycle for the instance. Valid values:

• Week.
• Month. This is the default value.

The automatic renewal period of the instance. The values that are valid for this parameter depend on the value specified in the PeriodUnit parameter. Valid values:

• Week:1, 2, and 3.
• Month:1, 2, 3, 6, 12, 24, 36, 48, and 60.

Default value: 1

The billing method of the instance. Valid values:

• PrePaid: The billing method is subscription.
• PostPaid: The billing method is pay-as-you-go. This is the default value.

If it is set to PrePaid, you must confirm that your payment account has sufficient credit. Otherwise, the InvalidPayMethod error code is returned.

The number of randomly generated IPv6 addresses that are allocated to the ENI.

The private IP address of the instance. This private IP address must be selected from the range defined by the CIDR block of the VSwitch.

Allocates one or more IPv6 addresses to the ENI. Currently, the value of N must be 1. Example:Ipv6Address.1=2001:db8:1234:1a00::***

Specifies whether to send a dry-run request.

• true: Only a dry-run request is sent and no instance is created. The system checks whether the required parameters are set, and validates the request format, service permissions, and available ECS instances. If the validation fails, the corresponding error code is returned. If the validation succeeds, the DryRunOperation error code is returned.
• false: A request is sent. If the validation succeeds, the instance is created. This is the default value.

The client token that is used to ensure the idempotence of the request. You can use your own methods to generate this value, but you must ensure that it is unique among different requests.ClientToken can only contain ASCII characters, and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

The list of security groups to which the instance belongs. The valid values for N are based on the maximum number of security groups that the specified instance supports. For more information, see Security group limits.

The performance level of the system disk. Valid values:

• PL1: a single ESSD delivers up to 50,000 random read/write IOPS. This is the default value.
• PL2: a single ESSD delivers up to 100,000 random read/write IOPS.
• PL3: a single ESSD delivers up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSD cloud disk.

The performance level of the Nth ESSD data disk. The value of N must be the same as that in DataDisk.N.Category=cloud_essd. Valid values:

• PL1: a single ESSD delivers up to 50,000 random read/write IOPS. This is the default value.
• PL2: a single ESSD delivers up to 100,000 random read/write IOPS.
• PL3: a single ESSD delivers up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSD cloud disk.

Specifies whether an instance on a dedicated host is associated with the dedicated host. This parameter is applicable to instances with the No Charges After Instance Is Stopped feature enabled. Valid values:

• default: The instance is not associated with the dedicated host. If the associated dedicated host has insufficient resources after the stopped instance is restarted, the instance is automatically allocated to an alternative dedicated host.
• host: The instance is associated with a specific dedicated host. The stopped instance still resides on the associated dedicated host after it is restarted. If the available resources of the original dedicated host are insufficient, the instance will fail to restart.

Default value: default

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

• default: creates an instance that is not on a dedicated host.
• host: creates an instance that is on a dedicated host. If you do not specify the DedicatedHostId parameter, then ECS automatically selects a dedicated host for the instance.

Default value: default