Creates one or more pay-as-you-go or subscription Elastic Compute Service (ECS) instances.

Description

  • Preparations:
    • Cost estimation: Learn about the billing methods of ECS resources. For more information, see Billing overview.
    • Instance type selection: Call the DescribeInstanceTypes operation to query the performance data of instance types, or see Best practices for instance type selection to learn about how to select instance types.
    • Query for available resources: Call the DescribeAvailableResource operation to query resources available in a specific region or zone.
    • Network planning: Make sure that you have security groups available for use. For more information, see CreateSecurityGroup. Before you create an instance of the Virtual Private Cloud (VPC) type, create a VPC in the region where you want to create the instance. For more information, see Create a VPC.
  • Comparison with CreateInstance:

    RunInstances has the following advantages over CreateInstance:

    • You can call the RunInstances operation to create up to 100 instances at a time, instead of repeatedly calling the CreateInstance operation.
    • After an instance is created, the instance enters the Starting state and then transitions to the Running state. You do not need to call the StartInstance operation to start the instance.
    • When you create an instance, you can specify InternetMaxBandwidthOut to assign a public IP address to the instance, without the need to call the AllocatePublicIpAddress operation.
    • You can specify AutoReleaseTime to set the time when to automatically release the instances, without the need to call the ModifyInstanceAutoReleaseTime operation.
    • You can specify LaunchTemplateId and LaunchTemplateVersion to use a launch template. This eliminates the need to configure a large number of parameters every time you create instances.
    • You can specify UniqueSuffix to batch configure sequential names or hostnames for multiple instances for easy management and retrieval.
    • When you call the RunInstances operation to create instances, you can configure the enclave-based confidential computing mode and the trusted system mode for the instances.
  • Precautions:
    • You can create up to 100 instances at a time.
    • You can use the AutoReleaseTime parameter to set the time when to automatically release the instances.
    • After instances are created, you can call the DescribeInstances operation to check their states.
    • By default, instances automatically start after they are created. Instances are ready for use when they are in the Running (Running) state.
    • As of November 27, 2020, the maximum bandwidth value available for you to create ECS instances or to change ECS instance configurations is subject to the throttling policy for your account. To increase the maximum bandwidth value, submit a ticket. The throttling policy imposes the following constraints: Within a single region, the total maximum bandwidth value of all instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total maximum bandwidth value of all instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
    • Different from the CreateInstance operation, the RunInstances operation allows the system to assign public IP addresses to the new instances if you set the InternetMaxBandwidthOut parameter to a value greater than 0.
    • When you call the RunInstances operation to create an instance, you can use one of the following methods to attach a primary elastic network interface (ENI) to the instance. Note that you can use only one of the methods to configure the primary ENI in each call. Otherwise, the call fails and an error message is returned.
      • Specify parameters such as SecurityGroupId, VSwitchId, PrivateIpAddress, NetworkInterfaceQueueNumber, and Ipv6AddressCount to configure the primary ENI.
      • Specify parameters that start with NetworkInterface.N. to configure the primary and secondary ENIs. If NetworkInterface.N.InstanceType is set to Primary, the primary ENI is attached to the instance. If NetworkInterface.N.InstanceType is set to Secondary or left empty, a secondary ENI is attached to the instance.
    • After you call this operation, an error is returned if a parameter is invalid or if available resources are insufficient. For more information, see the "Error codes" section of this topic.
Note If the QuotaExceed.ElasticQuota error is returned when you call this operation, you have reached the maximum number of instances of the specified instance type that can be created within the specified region or the maximum number of vCPUs for all instance types in a zone. You can go to the ECS console or Quota Center to request a quota increase.
  • Best practices:
    • We recommend that you use auto provisioning groups in the following scenarios: Resources are insufficient to create more than 100 instances at a time, you want to quickly create instances regardless of resource configurations such as instance types or zones, or you want to create instances to consume a specific total number of vCPUs regardless of the number of instances. You can call the CreateAutoProvisioningGroup operation to create an auto provisioning group to deploy an instance cluster across different billing methods, instance families, and zones. For more information, see Use auto provisioning group-related API operations to create multiple ECS instances at the same time.
    • You can call the RunInstances operation to batch create instances. To better manage and search for these instances, we recommend that you specify tags for the instances by using the Tag.N.Key and Tag.N.Value parameters. You can also append incremental suffixes (UniqueSuffix) to the hostname (HostName) and to the instance name (InstanceName).
    • A launch template contains parameters required to create an instance so that you do not have to specify these parameters every time you create instances. You can call the CreateLaunchTemplate operation to create a launch template. Then, in your request to call the RunInstances operation, you can specify the LaunchTemplateId and LaunchTemplateVersion parameters to use the launch template.
    • When you create an instance in the ECS console, you can view the best practices for calling the RunInstances operation. In the Preview step, click View Open API in the Configurations Selected section. In the dialog box that appears, the left-side API Workflow section shows the operations and request parameters that are related to the RunInstances operation. The right-side section shows SDK examples for the Java and Python programming languages.

Example 1: Create a subscription instance

Use the aliyun_3_x64_20G_alibase_20221102.vhd image to create a one-month subscription instance of the ecs.g7.large instance type in the China (Hangzhou) region, and enable auto-renewal to renew the instance for one month on expiration. The instance uses a 40 GiB enhanced SSD (ESSD) as the system disk and a 100 GiB ESSD as a data disk, and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password is ECS@test1234.


http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PrePaid
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&Amount=1
&Period=1
&PeriodUnit=Month
&AutoRenew=true
&AutoRenewPeriod=1
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&Common request parameters
            

Example 2: Create a pay-as-you-go instance

Use the aliyun_3_x64_20G_alibase_20221102.vhd image to create a pay-as-you-go instance of the ecs.g7.large instance type in the China (Hangzhou) region. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk, and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password is ECS@test1234.


http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PostPaid
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&Common request parameters
            

Example 3: Create a preemptible instance

Use the aliyun_3_x64_20G_alibase_20221102.vhd image to create a preemptible instance of the ecs.g7.large instance type that has a 1-hour protection period in the China (Hangzhou) region. The market price at the time of purchase is automatically used as the bid price. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk, and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password is ECS@test1234.


http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PostPaid
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&SpotStrategy=SpotAsPriceGo
&SpotDuration=1
&Common request parameters
            

Example 4: Create a subscription instance on a dedicated host

Use the aliyun_3_x64_20G_alibase_20221102.vhd image to create a one-month subscription instance of the ecs.g7.large instance type on the dh-bp12w10wll9xcjq2 dedicated host. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk, and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password is ECS@test1234.


http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PrePaid
&Amount=1
&Period=1
&PeriodUnit=Month
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&DedicatedHostId=dh-bp12w10wll9xcjq2****
&Common request parameters
            

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesRunInstances

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

RegionIdStringYescn-hangzhou

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

ImageIdStringNoaliyun_2_1903_x64_20G_alibase_20200324.vhd

The ID of the image. You can call the DescribeImages operation to query available images. If you do not use the LaunchTemplateId or LaunchTemplateName parameter to specify a launch template and do not set the ImageFamily parameter to obtain the latest available custom image from the specified image family, you must specify the ImageId parameter.

ImageFamilyStringNohangzhou-daily-update

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

  • If you set the ImageId parameter, you cannot set the ImageFamily parameter.
  • If you do not set the ImageId parameter but use the LaunchTemplateId or LaunchTemplateName parameter to specify a launch template that has the ImageId parameter set, you cannot set the ImageFamily parameter.
  • If you do not set the ImageId parameter but use the LaunchTemplateId or LaunchTemplateName parameter to specify a launch template that does not have the ImageId parameter set, you can set the ImageFamily parameter.
  • If you do not set the ImageId, LaunchTemplateId, or LaunchTemplateName parameter, you can set the ImageFamily parameter.
InstanceTypeStringNoecs.g6.large

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

SecurityGroupIdStringNosg-bp15ed6xe1yxeycg7****

The ID of the security group to which to assign the instance. Instances in the same security group can communicate with each other. The maximum 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 in Limits.

Note The network type of the new instance must be the same as that of the security group specified by the SecurityGroupId parameter. For example, if the specified security group is of the VPC type, the new instance is also of the VPC type and you must specify the VSwitchId parameter.

If you do not use LaunchTemplateId or LaunchTemplateName to specify a launch template, you must set the SecurityGroupId parameter. Take note of the following items:

  • You can set SecurityGroupId to specify a single security group or set SecurityGroupIds.N to specify one or more security groups. However, you cannot specify both SecurityGroupId and SecurityGroupIds.N.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify SecurityGroupId or SecurityGroupIds.N but can specify only NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N.
VSwitchIdStringNovsw-bp1s5fnvk4gn2tws0****

The ID of the vSwitch to which to connect to the instance. You must set this parameter when you create an instance of the VPC type. The specified vSwitch and security group must belong to the same VPC. You can call the DescribeVSwitches operation to query available vSwitches.

Take note of the following items:

  • If you specify the VSwitchId parameter, the zone specified by the ZoneId parameter must be the zone where the specified vSwitch resides. You can also leave the ZoneId parameter empty. Then, the system selects the zone where the specified vSwitch resides.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify VSwitchId but can specify NetworkInterface.N.VSwitchId.
InstanceNameStringNok8s-node-[1,4]-alibabacloud

The name of the instance. The name 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 (_), periods (.), and hyphens (-). The default value of this parameter is the InstanceId value.

When you batch create instances, you can batch configure sequential names for the instances. For more information, see Batch configure sequential names or hostnames for multiple instances.

DescriptionStringNoInstance_Description

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

InternetMaxBandwidthInIntegerNo10

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

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

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

Default value: 0.

HostNameStringNok8s-node-[1,4]-ecshost

The hostname of the instance. Take note of the following items:

  • 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 cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).
  • For instances that run other operating systems such as Linux, take note of the following items:
    • The hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
    • You can use the ${instance_id} placeholder to pass instance IDs into the hostname specified by HostName. For example, if you set HostName to k8s-${instance_id} and the instance is assigned an ID of i-123abc****, the hostname of the instance is k8s-i-123abc****.

When you create multiple instances, you can perform the following operations:

UniqueSuffixBooleanNotrue

Specifies whether to automatically append incremental suffixes to the hostname specified by the HostName parameter and to the instance name specified by the InstanceName parameter when you batch create instances. The incremental suffixes can range from 001 to 999. Valid values:

  • true: appends incremental suffixes to the hostname and the instance name.
  • false: does not append incremental suffixes to the hostname or the instance name.

Default value: false.

When the HostName or InstanceName value is set in the name_prefix[begin_number,bits] format without name_suffix, the UniqueSuffix parameter does not take effect. The names are sorted in the specified sequence.

For more information, see Batch configure sequential names or hostnames for multiple instances.

PasswordStringNoEcsV587!

The password of the instance. The password must be 8 to 30 characters in length and contain 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 (/).

Note For security reasons, we recommend that you use HTTPS to send requests if the Password parameter is specified.
PasswordInheritBooleanNofalse

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

  • true: uses the preset password.
  • false: does not use the preset password.

Default value: false.

Note If you set this parameter to true, leave Password empty and make sure that the selected image has a password preset.
ZoneIdStringNocn-hangzhou-g

The ID of the zone in which to create the instance. You can call the DescribeZones operation to query the most recent zone list.

Note If the VSwitchId parameter is specified, the zone specified by the ZoneId parameter must be the zone where the vSwitch resides. You can also leave the ZoneId parameter empty. Then, the system selects the zone where the specified vSwitch resides.

This parameter is empty by default.

InternetChargeTypeStringNoPayByTraffic

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth
  • PayByTraffic: pay-by-traffic.

Default value: PayByTraffic.

Note When the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidth values are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidth values may not be reached. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage.
SystemDisk.SizeStringNo40

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 specified image.

Default value: 40 or the image size, whichever is greater.

SystemDisk.CategoryStringNocloud_ssd

The category of the system disk. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD)
  • cloud: basic disk
  • cloud_auto: ESSD AutoPL 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.

SystemDisk.DiskNameStringNocloud_ssdSystem

The name of the system disk. The name 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, periods (.), colons (:), underscores (_), and hyphens (-).

SystemDisk.DescriptionStringNoSystemDisk_Description

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

SystemDisk.PerformanceLevelStringNoPL0

The performance level of the ESSD to use as the system disk. 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 ESSDs.

SystemDisk.AutoSnapshotPolicyIdStringNosp-bp67acfmxazb4p****

The ID of the automatic snapshot policy to apply to the system disk.

IoOptimizedStringNooptimized

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

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

The user data of the instance. The user data must be encoded in Base64. The raw data can be up to 16 KB in size.

Note If the instance type supports user data, you can use the UserData parameter to pass in user data. We recommend that you do not pass in confidential information (such as passwords or private keys) in plaintext as user data. This is because the system does not encrypt UserData values when API requests are transmitted. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64, and then decode and decrypt the information in the same way inside the instance.
KeyPairNameStringNoKeyPair_Name

The name of the key pair to bind to the instance.

Note For Windows instances, this parameter is ignored. This parameter is empty by default. The Password parameter is valid even if the KeyPairName parameter is specified.
RamRoleNameStringNoRAM_Name

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

AmountIntegerNo3

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

Default value: 1.

MinAmountIntegerNo2

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

  • If the number of instances that available resources are sufficient to create is smaller than the MinAmount value, instances cannot be created.
  • If the number of instances that available resources are sufficient to create is greater than or equal to the MinAmount value, instances are created based on the number of available resources.
AutoReleaseTimeStringNo2018-01-01T12:05:00Z

The time when to automatically release 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 time is automatically rounded to the nearest minute based on the value of minutes (mm).
  • The specified time must be at least 30 minutes later than the current time.
  • The specified time can be at most three years from the current time.
SpotStrategyStringNoNoSpot

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

  • NoSpot: The instance is created as a pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.

Default value: NoSpot.

SpotDurationIntegerNo1

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

  • The following protection periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. 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.

SpotPriceLimitFloatNo0.97

The maximum hourly price of the instance. The value is accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.

SpotInterruptionBehaviorStringNoTerminate

The interruption mode of the preemptible instance. Default value: Terminate. Set the value to Terminate, which indicates that the instance is released.

SecurityEnhancementStrategyStringNoActive

Specifies whether to enable security hardening. Valid values:

  • Active: enables security hardening. This value is applicable only to public images.
  • Deactive: does not enable security hardening. This value is applicable to all images.
ClientTokenStringNo123e4567-e89b-12d3-a456-426655440000

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

HpcClusterIdStringNohpc-bp67acfmxazb4p****

The ID of the Elastic High Performance Computing (E-HPC) cluster to which to assign the instance.

DryRunBooleanNofalse

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 whether required parameters are specified, the 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 validity of the request is checked, and the request is made if the check succeeds.
DedicatedHostIdStringNodh-bp67acfmxazb4p****

The ID of the dedicated host on which to create the instance. If you set the DedicatedHostId parameter, 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 list of dedicated host IDs.

LaunchTemplateIdStringNolt-bp1apo0bbbkuy0rj****

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

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

LaunchTemplateNameStringNoLaunchTemplate_Name

The name of the launch template.

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

LaunchTemplateVersionLongNo3

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

ResourceGroupIdStringNorg-bp67acfmxazb4p****

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

PeriodIntegerNo1

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 value of Period must not exceed the subscription period of the specified 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.

PeriodUnitStringNoMonth

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

Month

AutoRenewBooleanNotrue

Specifies whether to enable auto-renewal for the instance. This parameter is valid only when the InstanceChargeType parameter is set to PrePaid. Valid values:

  • true: enables auto-renewal.
  • false: does not enable auto-renewal.

Default value: false.

AutoRenewPeriodIntegerNo1

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.

InstanceChargeTypeStringNoPrePaid

The billing method of the instance. Valid values:

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

Default value: PostPaid.

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

DeploymentSetIdStringNods-bp1brhwhoqinyjd6****

The ID of the deployment set to which to deploy the instance.

DeploymentSetGroupNoIntegerNo1

The number of the deployment set group to which to deploy the instance. If the deployment set specified by the DeploymentSetId parameter uses the high availability group strategy (AvailabilityGroup), you can use the DeploymentSetGroupNo parameter to specify a deployment set group in the deployment set. Valid values: 1 to 7.

PrivateIpAddressStringNo10.1.**.**

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

Take note of the following items:

  • If the PrivateIpAddress parameter is specified, take note of the following items:
    • If Amount is set to 1, a single instance is created and the specified private IP address is assigned to the instance.
    • If Amount is set to a numeric value greater than 1, the specified number of instances are created and consecutive private IP addresses starting from the specified one are assigned to the instances. In this case, you cannot specify parameters that start with NetworkInterface.N to attach secondary ENIs to the instances.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify PrivateIpAddress but can specify NetworkInterface.N.PrimaryIpAddress.
CreditSpecificationStringNoStandard

The performance mode of the burstable instance. Valid values:

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

The number of IPv6 addresses to randomly generate for the primary ENI. Valid values: 1 to 10.

Take note of the following items:

  • You cannot specify both the Ipv6Addresses.N and Ipv6AddressCount parameters.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify Ipv6Address.N or Ipv6AddressCount but can specify NetworkInterface.N.Ipv6Address.N or NetworkInterface.N.Ipv6AddressCount.
NetworkInterfaceQueueNumberIntegerNo8

The number of queues supported by the primary ENI. Take note of the following items:

  • 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 on the instance cannot exceed the queue quota for the instance type. To query the maximum number of queues per ENI and the queue quota for an instance type, you can call the DescribeInstanceTypes operation to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity values.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify NetworkInterfaceQueueNumber but can specify NetworkInterface.N.QueueNumber.
DeletionProtectionBooleanNofalse

Specifies whether to enable release protection for the instance. This parameter determines whether you can use the ECS console or call the DeleteInstance operation to release the instance. Valid values:

  • true: enables release protection for the instance.
  • false: disables release protection for the instance.

Default value: false.

Note This parameter is applicable only to pay-as-you-go instances. It can protect instances against manual releases, but not against automatic releases.
HibernationOptions.ConfiguredBooleanNofalse
Note This parameter is in invitational preview and unavailable to general users.
AffinityStringNodefault

Specifies whether to associate an instance on a dedicated host with the dedicated host. Valid values:

  • default: does not associate the instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient.
  • host: associates the instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host of the instance has insufficient resources, the instance cannot be started.

Default value: default.

TenancyStringNodefault

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 set the DedicatedHostId parameter, Alibaba Cloud selects a dedicated host for the instance.

Default value: default.

StorageSetIdStringNoss-bp67acfmxazb4p****

The ID of the storage set.

StorageSetPartitionNumberIntegerNo2

The maximum number of partitions in the storage set. The value must be greater than or equal to 2.

CpuOptions.CoreIntegerNo2

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

CpuOptions.ThreadsPerCoreIntegerNo2

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

  • If CpuOptions.ThreadPerCore is set to 1, hyperthreading is disabled.
  • This parameter is applicable only to specific instance types.
CpuOptions.NumaStringNo1

This parameter is no longer used.

SecurityOptions.TrustedSystemModeStringNovTPM

The trusted system mode. Set the value to vTPM.

The trusted system mode supports the following instance families:

  • g7, c7, and r7
  • Security-enhanced instance families: g7t, c7t, and r7t

When you create instances of the preceding instance families, you must set this parameter. Take note of the following items:

  • To use the Alibaba Cloud trusted system, set this parameter to vTPM. Then, the Alibaba Cloud trusted system performs trust verifications when the instances start.
  • If you do not want to use the Alibaba Cloud trusted system, leave this parameter empty. Note that if your created instances use an enclave-based confidential computing environment (with SecurityOptions.ConfidentialComputingMode set to Enclave), the Alibaba Cloud trusted system is enabled for the instances.
  • When you use the ECS API to create instances that use the trusted system, you can call only the RunInstances operation. The CreateInstance operation does not support the SecurityOptions.TrustedSystemMode parameter.
    Note If you have configured an instance as a trusted one when you created the instance, you can use only an image that supports the trusted system to replace the system disk of the instance.

For more information about the trusted system, see Overview.

SecurityOptions.ConfidentialComputingModeStringNoEnclave

The confidential computing mode. Set the value to Enclave.

A value of Enclave indicates that an enclave-based confidential computing environment is built on the instance. When you call the RunInstances operation, you can set this parameter only for c7, g7, or r7 instances to use enclave-based confidential computing. Take note of the following items:

  • The confidential computing feature is in invitational preview.
  • When you use the ECS API to create instances that support enclave-based confidential computing, you can call only the RunInstances operation. The CreateInstance operation does not support the SecurityOptions.ConfidentialComputingMode parameter.
  • Enclave-based confidential computing is implemented based on the Alibaba Cloud trusted system (vTPM). When you build a confidential computing environment on an instance by using Enclave, the Alibaba Cloud trusted system is enabled for the instance. If you set SecurityOptions.ConfidentialComputingMode to Enclave when you call this operation, the created instances use enclave-based confidential computing and the Alibaba Cloud trusted system regardless of whether SecurityOptions.TrustedSystemMode is set to vTPM.

For more information about confidential computing, see Build a confidential computing environment by using Enclave.

HttpEndpointStringNoenabled

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

  • enabled: enables the access channel for instance metadata.
  • disabled: disables the access channel for instance metadata.

Default value: enabled.

Note For more information about instance metadata, see Overview of ECS instance metadata.
HttpTokensStringNooptional

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

  • optional: does not forcefully use the security-enhanced mode (IMDSv2).
  • required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode.

Default value: optional.

Note For more information about modes of accessing instance metadata, see Access mode of instance metadata.
HttpPutResponseHopLimitIntegerNo3

The HTTP PUT response hop limit for accessing instance metadata. Valid values: 1 to 64.

Default value: 1.

PrivatePoolOptions.MatchCriteriaStringNoOpen

The type of the private pool to use to create the instance. A private pool is generated when an elasticity assurance or a capacity reservation takes effect. You can select a private pool to create instances. Valid values:

  • Open: open private pool. The system selects a matching open private pool to create the instance. If no matching open private pools are found, resources in the public pool are used. When you set this parameter to Open, you can leave the PrivatePoolOptions.Id parameter empty.
  • Target: specified private pool. The system uses the capacity in a specified private pool to create the instance. If the specified private pool is unavailable, the instance cannot be created. If you set this parameter to Target, you must specify the PrivatePoolOptions.Id parameter.
  • None: no private pool. The capacity in private pools is not used.

Default value: None.

In the following scenarios, the PrivatePoolOptions.MatchCriteria parameter can be set only to None or left empty:

  • Create a preemptible instance.
  • Create an instance in the classic network.
  • Create an instance on a dedicated host.
PrivatePoolOptions.IdStringNoeap-bp67acfmxazb4****

The ID of the private pool. The ID of a private pool is the same as that of the elasticity assurance or capacity reservation for which the private pool is generated.

IspStringNonull
Note This parameter is in invitational preview and unavailable to general users.
SchedulerOptions.DedicatedHostClusterIdStringNodc-bp12wlf6am0vz9v2****

The ID of the dedicated host cluster in which to create the instance. After this parameter is specified, the system selects one dedicated host from the specified cluster to create the instance.

Note This parameter is valid only when the Tenancy parameter is set to host.

When you specify both the DedicatedHostId and SchedulerOptions.DedicatedHostClusterId parameters, take note of the following items:

  • If the specified dedicated host belongs to the specified dedicated host cluster, the instance is preferentially deployed on the specified dedicated host.
  • If the specified dedicated host does not belong to the specified dedicated host cluster, the instance cannot be created.

You can call the DescribeDedicatedHostClusters operation to query the list of dedicated host cluster IDs.

SecurityGroupIds.NStringNosg-bp15ed6xe1yxeycg7****

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

Take note of the following items:

  • You cannot specify both the SecurityGroupId and SecurityGroupIds.N parameters.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify SecurityGroupId or SecurityGroupIds.N but can specify NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N.
HostNames.NStringNoecs-host-01

The hostname of instance N. You can use this parameter to specify different hostnames for multiple instances. Take note of the following items:

  • The maximum value of N must be the same as the Amount value. For example, if you set Amount to 2, you can use HostNames.1 and HostNames.2 to specify hostnames for the individual instances. Examples: HostNames.1=test1 and HostNames.2=test2.
  • You cannot specify both the HostName and HostNames.N parameters.
  • 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 cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-).
  • 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 a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
DataDisk.N.PerformanceLevelStringNoPL1

The performance level of the ESSD to use as data disk N. The value of N 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 ESSDs.

DataDisk.N.AutoSnapshotPolicyIdStringNosp-bp67acfmxazb4p****

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

DataDisk.N.EncryptedStringNofalse

Specifies whether to encrypt data disk N. Valid values:

  • true: encrypts data disk N.
  • false: does not encrypt data disk N.

Default value: false.

DataDisk.N.DescriptionStringNoDataDisk_Description

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

DataDisk.N.SnapshotIdStringNos-bp17441ohwka0yuh****

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

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

DataDisk.N.DeviceStringNo/dev/xvdb

The mount point of data disk N.

Note This parameter is applicable to scenarios in which a full image is used to create instances. A full image is an image that contains an operating system, application software, and business data. For these scenarios, you can set this parameter to the mount point of data disk N contained in the full image and modify the DataDisk.N.Size and DataDisk.N.Category parameters to change the category and size of data disk N created based on the image.
DataDisk.N.SizeIntegerNo2000

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: depend on the DataDisk.N.PerformanceLevel value.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL0: 40 to 32768.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL1: 20 to 32768.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL2: 461 to 32768.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL3: 1261 to 32768.
  • Valid values when DataDisk.N.Category is set to cloud: 5 to 2000.
  • Valid values when DataDisk.N.Category is set to cloud_auto: 40 to 32768.

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

DataDisk.N.DiskNameStringNocloud_ssdData

The name of data disk N. The name 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, periods (.), colons (:), underscores (_), and hyphens (-).

DataDisk.N.CategoryStringNocloud_ssd

The category of data disk N. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • cloud: basic disk
  • cloud_auto: ESSD AutoPL disk

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

DataDisk.N.EncryptAlgorithmStringNoaes-256

The algorithm to use to encrypt data disk N. Valid values:

  • aes-256
  • sm4-128

Default value: aes-256.

DataDisk.N.DeleteWithInstanceBooleanNotrue

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

  • true: releases data disk N when the instance is released.
  • false: does not release data disk N when the instance is released.

Default value: true.

DataDisk.N.KMSKeyIdStringNo0e478b7a-4262-4802-b8cb-00d3fb40****

The ID of the Key Management Service (KMS) key to use for data disk N.

DataDisk.N.StorageClusterIdStringNodbsc-j5e1sf2vaf5he8m2****

The ID of the dedicated block storage cluster. If you want to use a disk in a dedicated block storage cluster as data disk N when you create instances, you must specify this parameter.

DataDisk.N.ProvisionedIopsLongNo40000

The provisioned read/write IOPS of the ESSD AutoPL disk to be used as data disk N. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}

Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}

Note This parameter is available only if you set the DataDisk.N.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks.
DataDisk.N.BurstingEnabledBooleanNofalse

Specifies whether to enable the performance burst feature for data disk N. Valid values:

  • true: enables the performance burst feature.
  • false: does not enable the performance burst feature.
Note This parameter is available only if you set the DataDisk.N.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks.
Arn.N.RoleTypeStringNonull

This parameter is unavailable.

Arn.N.RolearnStringNonull

This parameter is unavailable.

Arn.N.AssumeRoleForLongNo0

This parameter is unavailable.

NetworkInterface.N.VSwitchIdStringNovsw-bp67acfmxazb4p****

The ID of the vSwitch to which to connect to ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. In this case, this parameter is equivalent to VSwitchId. You cannot specify both NetworkInterface.N.VSwitchId and VSwitchId.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the ID of the vSwitch to which to connect the instance.
NetworkInterface.N.NetworkInterfaceNameStringNoNetwork_Name

The name of ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you can configure a primary ENI and a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, you do not need to set this parameter.
NetworkInterface.N.DescriptionStringNoNetwork_Description

The description of ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you can configure a primary ENI and a secondary ENI.
  • The description must be 2 to 256 characters in length and cannot start with http:// or https://.
  • If NetworkInterface.N.InstanceType is set to Primary, you do not need to set this parameter.
NetworkInterface.N.SecurityGroupIdStringNosg-bp67acfmxazb4p****

The ID of the security group to which to assign secondary ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. In this case, this parameter is equivalent to SecurityGroupId and you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the ID of the security group to which to assign the ECS instance.
NetworkInterface.N.PrimaryIpAddressStringNo172.16.**.**

The primary IP address to assign to ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2.
    • If the value of N is 1, you can configure a primary or secondary ENI. If this parameter is specified, Amount is set to a numeric value greater than 1, and NetworkInterface.N.InstanceType is set to Primary, the specified number of instances are created and consecutive primary IP addresses starting from the specified one are assigned to the instances. In this case, you cannot attach secondary ENIs to the instances.
    • If the value of N is 2, you can configure a primary ENI and a secondary ENI. If this parameter is specified, Amount is set to a numeric value greater than 1, and NetworkInterface.N.InstanceType is set to Primary, you cannot set NetworkInterface.2.InstanceType to Secondary to attach a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, this parameter is equivalent to PrivateIpAddress. You cannot specify both NetworkInterface.N.PrimaryIpAddress and PrivateIpAddress.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, the specified primary IP address is assigned to the secondary ENI. The default value is an IP address that is randomly selected from within the CIDR block of the vSwitch to which to connect the secondary ENI.
Note You can attach only a single secondary ENI when you create an instance. After the instance is created, you can call the CreateNetworkInterface and AttachNetworkInterface operations to attach more secondary ENIs.
NetworkInterface.N.QueueNumberIntegerNo8

The number of queues supported by ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you can configure a primary ENI and a secondary 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 on the instance cannot exceed the queue quota for the instance type. To query the maximum number of queues per ENI and the queue quota for an instance type, you can call the DescribeInstanceTypes operation to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity values.
  • If this parameter is set and NetworkInterface.N.InstanceType is set to Primary, you cannot set the NetworkInterfaceQueueNumber parameter.
NetworkInterface.N.SecurityGroupIds.NStringNosg-bp15ed6xe1yxeycg7****

The ID of security group N to which to assign ENI N.

  • Valid values of the first N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you can configure a primary ENI and a secondary ENI.
  • The second N indicates that one or more security group IDs can be specified. The valid values of N vary based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in Limits.

Take note of the following items:

  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter or NetworkInterface.N.SecurityGroupId. In this case, this parameter is equivalent to SecurityGroupIds.N and you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the ID of the security group to which to assign the ECS instance.
NetworkInterface.N.NetworkInterfaceTrafficModeStringNoStandard

The communication mode of primary ENI N. Valid values:

  • Standard: uses the TCP communication mode.
  • HighPerformance: enables Elastic RDMA Interface (ERI) and uses the remote direct memory access (RDMA) communication mode.

Take note of the following items:

  • This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If NetworkInterface.N.InstanceType is set to Secondary or left empty, you cannot set this parameter.
  • If you set this parameter to HighPerformance, you can create instances only of the c7re RDMA-enhanced instance family. The maximum number of ENIs in RDMA mode that can be attached to a c7re instance is determined based on the instance type. The c7re instance family is in invitational preview in Beijing Zone K. For more information, see Instance families.
NetworkInterface.N.QueuePairNumberLongNo0
Note This parameter is in invitational preview and unavailable to general users.
NetworkInterface.N.InstanceTypeStringNoSecondary

The type of ENI N. Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you can configure a primary ENI and a secondary ENI.

Valid values:

  • Primary
  • Secondary

Default value: Secondary.

NetworkInterface.N.Ipv6AddressCountLongNo1

The number of IPv6 addresses to randomly generate for the primary ENI. Valid values: 1 to 10.

Take note of the following items:

  • This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If NetworkInterface.N.InstanceType is set to Secondary or left empty, you cannot set this parameter.
  • If this parameter is specified, you cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6Address.N.
NetworkInterface.N.Ipv6Address.NStringNo2001:db8:1234:1a00::***

IPv6 address N to assign to primary ENI N. Up to 10 IPv6 addresses can be assigned. Valid values of the second N: 1 to 10.

Example: Ipv6Address.1=2001:db8:1234:1a00::***.

Take note of the following items:

  • This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If NetworkInterface.N.InstanceType is set to Secondary or left empty, you cannot set this parameter.
  • If this parameter is specified, you must set Amount to 1. You cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6AddressCount.
Tag.N.KeyStringNoTestKey

The key of tag N to add 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://.

Tag.N.ValueStringNoTestValue

The value of tag N to add 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: or contain http:// or https://.

Ipv6Address.NStringNo2001:db8:1234:1a00::***

IPv6 address N to assign to the primary ENI. Valid values of N: 1 to 10.

Example: Ipv6Address.1=2001:db8:1234:1a00::***.

Take note of the following items:

  • If the Ipv6Address.N parameter is specified, you must set the Amount parameter to 1 and leave the Ipv6AddressCount parameter empty.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set Ipv6Addresses.N or Ipv6AddressCount. You must set NetworkInterface.N.Ipv6Addresses.N or NetworkInterface.N.Ipv6AddressCount.
SystemDisk.StorageClusterIdStringNodbsc-j5e1sf2vaf5he8m2****

The ID of the dedicated block storage cluster. If you want to use disks in a dedicated block storage cluster as system disks when you create instances, you must specify this parameter. For more information about dedicated block storage clusters, see What is Dedicated Block Storage Cluster?

SystemDisk.ProvisionedIopsLongNo40000

The provisioned read/write IOPS of the ESSD AutoPL disk to be used as the system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline performance}

Baseline performance = min{1,800 + 50 × Capacity, 50,000}

Note This parameter is available only if you set the SystemDisk.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks.
SystemDisk.BurstingEnabledBooleanNofalse

Specifies whether to enable the performance burst feature for the system disk. Valid values:

  • true: enables the performance burst feature.
  • false: does not enable the performance burst feature.
Note This parameter is available only if you set the SystemDisk.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks.
SystemDisk.EncryptedStringNofalse

Specifies whether to encrypt the system disk. Valid values:

  • true: encrypts the system disk.
  • false: does not encrypt the system disk.

Default value: false.

Note The system disks of instances cannot be encrypted during instance creation in Hong Kong Zone D or Singapore Zone A.
SystemDisk.KMSKeyIdStringNo0e478b7a-4262-4802-b8cb-00d3fb40****

The ID of the KMS key to use for the system disk.

SystemDisk.EncryptAlgorithmStringNoase-256

The algorithm to use to encrypt the system disk. Valid values:

  • ase-256
  • sm4-128

Default value: ase-256.

Response parameters

ParameterTypeExampleDescription
RequestIdString473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

The ID of the request.

OrderIdString123456****

The ID of the order. This parameter is returned only when InstanceChargeType is set to PrePaid.

TradePriceFloat0.165

The transaction price.

InstanceIdSetsArray of String["i-bp67acfmxazb4pd2****", "i-bp1i43l28m7u48p1****", "i-bp12yqg7jdyxl11f****"]

The IDs of the instances (InstanceIdSet).

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_2_1903_x64_20G_alibase_20200324.vhd
&InstanceType=ecs.g6.large
&SecurityGroupId=sg-bp67acfmxazb4p****
&VSwitchId=vsw-bp1s5fnvk4gn2tws0****
&SystemDisk.AutoSnapshotPolicyId=sp-bp67acfmxazb4p****
&Amount=3
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<RunInstancesResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <OrderId>1234567890</OrderId>
    <TradePrice>0.165</TradePrice>
    <InstanceIdSets>["i-bp67acfmxazb4pd2****", "i-bp1i43l28m7u48p1****", "i-bp12yqg7jdyxl11f****"]</InstanceIdSets>
</RunInstancesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "OrderId" : "123456****",
  "TradePrice" : 0.165,
  "InstanceIdSets" : [ "[\"i-bp67acfmxazb4pd2****\", \"i-bp1i43l28m7u48p1****\", \"i-bp12yqg7jdyxl11f****\"]" ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.The error message returned because you are not authorized to use the specified instance type.
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType beyond the permitted range.The error message returned because the specified InstanceType parameter is invalid.
400InvalidDescription.MalformedThe specified parameter "Description" is not valid.The error message returned because the specified Description parameter is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400InvalidInternetChargeType.ValueNotSupportedThe specified InternetChargeType is not valid.The error message returned because the specified InternetChargeType parameter is invalid.
400InvalidPasswordParam.MismatchThe input password should be null when passwdInherit is true.The error message returned because the Password parameter is not left empty when PasswdInherit is set to true.
400InvalidDataDiskSize.ValueNotSupportedThe specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.The error message returned because the specified DataDisk.N.Size parameter is invalid or because the snapshot size exceeds the maximum capacity allowed for the specified disk category.
400InvalidInnerIpAddress.UnusableThe specified InnerIpAddress is already used or not found in usable ip range.The error message returned because the specified internal IP address is unavailable.
400InvalidParameter.ConflictThe specified image does not support the specified instance type.The error message returned because the specified image does not support the specified instance type.
400ImageNotSupportCloudInitThe specified image does not support cloud-init.The error message returned because the specified image does not support cloud-init.
400InvalidSnapshotId.BasedSnapshotTooOldThe specified snapshot is created before 2013-07-15.The error message returned because the specified snapshot was created before July 15, 2013.
400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.The error message returned because the maximum number of active pay-as-you-go instances has been reached.
400InvalidParameter.ConflictThe speicified region and cluster do not match.The error message returned because the specified region and cluster do not correspond to each other.
400InvalidParameter.MismatchSpecified security group and virtual switch are not in the same VPC.The error message returned because the specified security group and vSwitch do not belong to the same VPC.
400InvalidPrivateIpAddressSpecified private IP address is not in the CIDR block of virtual switch.The error message returned because the specified private IP address is not within the CIDR block of the vSwitch.
400InvalidPrivateIpAddress.MalformedSpecified private IP address is malformed.The error message returned because the specified PrivateIpAddress parameter is invalid.
400InvalidPrivateIpAddress.DuplicatedSpecified private IP address is duplicated.The error message returned because the specified private IP address is already in use. Try a different IP address.
400QuotaExceededLiving instances quota exceeded in this VPC.The error message returned because the maximum number of active instances has been reached.
400IncorrectVSwitchStatusThe current status of virtual switch does not support this operation.The error message returned because the specified vSwitch is in the Pending state and cannot be deleted.
400InvalidParameter.MismatchSpecified virtual switch is not in the specified zone.The error message returned because the specified vSwitch does not exist in the specified zone.
400ResourceNotAvailableResource you requested is not available in this region or zone.The error message returned because VPC is not supported in the specified region or zone.
400InvalidPeriodThe specified period is not valid.The error message returned because the specified Period parameter is invalid.
400InstanceDiskCategoryLimitExceedThe specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.The error message returned because the specified DataDisk.N.Size parameter is invalid or because the snapshot size exceeds the maximum capacity allowed for the specified disk category.
400InvalidInstanceType.ValueNotSupportedInternetMaxBandwidthOut should be set.The error message returned because the InternetMaxBandwidthOut parameter is not specified.
400InvalidClientToken.ValueNotSupportedThe ClientToken provided is invalid.The error message returned because the specified ClientToken parameter is invalid.
400InvalidIoOptimize.ValueNotSupportedThe specified IoOptimize is not valid.The error message returned because the specified IoOptimized parameter is invalid.
400InvalidSecurityGroupId.NotFoundThe SecurityGroupId provided does not exist in our records.The error message returned because the specified security group does not exist in this account. Check whether the security group ID is correct.
400InvalidHostName.MalformedThe specified parameter HostName is not valid.The error message returned because the specified HostName parameter is invalid.
400InvalidInternetMaxBandwidthOut.MalformedThe specified parameter internetMaxBandwidthOut is not valid.The error message returned because the specified InternetMaxBandwidthOut parameter is invalid.
400InvalidInternetMaxBandwidthIn.MalformedThe specified parameter internetMaxBandwidthIn is not valid.The error message returned because the specified InternetMaxBandwidthIn parameter is invalid.
400InvalidSnapshotId.NotFoundThe specified parameter SnapshotId is not exist.The error message returned because the specified snapshot does not exist.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The error message returned because the specified Tag.N.Key parameter is invalid.
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The error message returned because the specified Tag.N.Value parameter is invalid.
400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.The error message returned because the specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400InvalidTagCountThe specified tags are beyond the permitted range.The error message returned because the number of specified tags exceeds the upper limit.
400InvalidMinAmount.MalformedThe specified parameter MinAmount is not valid.The error message returned because the specified MinAmount parameter is invalid.
400InvalidMaxAmount.MalformedThe specified parameter MaxAmount is not valid.The error message returned because the specified MaxAmount parameter is invalid.
400InvalidAutoReleaseTime.MalformedThe specified parameter AutoReleaseTime is not valid.The error message returned because the specified AutoReleaseTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidPrivateIpAddress.MalformedThe specified parameter PrivateIpAddress is not valid.The error message returned because the specified PrivateIpAddress parameter is invalid.
400InvalidInnerIpAddress.MalformedThe specified parameter InnerIpAddress is not valid.The error message returned because the specified internal IP address is invalid.
400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.The error message returned because the number of specified tags exceeds the upper limit.
400Account.ArrearageYour account has been in arrears.The error message returned because your account balance is insufficient. Add funds to your account and try again.
400InvalidUserData.Base64FormatInvalidThe specified UserData is not valid.The error message returned because the specified user data is invalid.
400InstanceDiskNumber.LimitExceedThe total number of specified disk in an instance exceeds.The error message returned because the number of specified disks exceeds the upper limit for an instance.
400InvalidSpotStrategyThe specified SpotStrategy is not valid.The error message returned because the specified SpotStrategy parameter is invalid.
400InvalidSpotPriceLimitThe specified SpotPriceLimitis not valid.The error message returned because the specified SpotPriceLimit parameter is invalid.
400InvalidSpotDurationThe specified SpotDuration is not valid.The error message returned because the specified SpotDuration parameter is invalid.
400InvalidSpotAuthorizedThe specified Spot param is unauthorized.The error message returned because you are not authorized to set the SpotDuration parameter.
400InvalidSpotPrepaidThe specified Spot type is not support PrePay Instance.The error message returned because preemptible instances do not support the subscription billing method.
400InvalidSpotAliUidThe specified UID is not authorized to use SPOT instance.The error message returned because you are not authorized to create preemptible instances.
400InvalidParameter.Bandwidth%sThe error message returned because the specified bandwidth is invalid.
400InvalidDataDiskCategory.ValueNotSupported%sThe error message returned because the specified disk category is invalid. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidSystemDiskCategory.ValueNotSupported%sThe error message returned because the operation is not supported by the specified system disk category.
400InvalidParameter.Conflict%sThe error message returned because a specified parameter is invalid. Check whether parameter conflicts exist. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidInternetChargeType.ValueNotSupported%sThe error message returned because the specified InternetChargeType parameter is invalid.
400InvalidInstanceType.ValueNotSupported%sThe error message returned because the operation is not supported by the specified instance type.
400RegionUnauthorized%sThe error message returned because you are not authorized to perform the operation in the specified region. %s is a variable. An error message is dynamically returned based on call conditions.
400Zone.NotOnSale%sThe error message returned because the requested resources are unavailable in the specified zone. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidSystemDiskSize.ValueNotSupported%sThe error message returned because the specified system disk size is invalid.
400InvalidDataDiskSize.ValueNotSupported%sThe error message returned because the specified data disk size is invalid. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidInstanceType.ElasticNetworkInterfaceNotSupportedThe specified instance type does not support Elastic Network Interface, you can not attach Elastic Network Interface to generation I instances.The error message returned because ENIs are not supported by the specified instance type.
400InvalidParameter.EncryptedIllegal%sThe error message returned because the specified parameter is invalid. Check whether your encryption operation is valid. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidParameter.EncryptedNotSupported%sThe error message returned because disk encryption is not supported by the specified disk category.
400InvalidRelationResource.NotFoundThe relation resource has been deleted.The error message returned because the associated resource has been deleted.
400IncorrectRecycleBinStatusThe operation is not permitted due to resource status.The error message returned because the operation is not supported while the resource is in the current state.
400InvalidHpcClusterId.UnnecessaryThe specified HpcClusterId is unnecessary.The error message returned because the HpcClusterId parameter is specified.
400InvalidVSwitchId.NecessaryThe VSwitchId is necessary.The error message returned because the VSwitchId parameter is not specified.
400InvalidHpcClusterId.NecessaryThe HpcClusterId is necessary.The error message returned because the HpcClusterId parameter is not specified.
400InvalidHpcClusterId.NotFoundThe specified HpcClusterId is not found.The error message returned because the specified HpcClusterId parameter does not exist.
400InvalidHpcClusterId.CreatingThe specified HpcClusterId is creating.The error message returned because the specified HPC cluster is being created.
400InvalidSecurityGroup.NotInDefaultVpc%sThe error message returned because the specified security group is not in the default VPC. Check whether the specified SecurityGroupId parameter is correct.
400VpcNotFoundVpc is not found according to the specified VSwitch or the vpc does not belong to you.The error message returned because no VPC is found based on the specified vSwitch or because the corresponding VPC does not belong to you.
400InvalidSystemDiskSize.ImageNotSupportResizeThe specified image does not support resize.The error message returned because the specified image cannot be resized.
400InvalidSpotInterruptionBehavior%sThe error message returned because the specified SpotInterruptionBehavior parameter is invalid.
400InvalidDeploymentOnHost%sThe error message returned because the instance cannot be deployed in the specified deployment set.
400InvalidInstanceChargeType.NotSupportThe Dedicated host not support the specified Instance charge type.The error message returned because the dedicated host does not support instances that use the specified billing method.
400InvalidDedicatedHostId.NotFoundThe specified DedicatedHostId does not exist.The error message returned because the specified dedicated host does not exist.
400InvalidDedicatedHostStatus.NotSupportOperation denied due to dedicated host status.The error message returned because the operation is not supported while the dedicated host is in the current state.
400IncorrectDedicatedHostStatusThe current status of the resource does not support this operation.The error message returned because the operation is not supported while the resource is in the current state.
400ChargeTypeViolation.PostPaidDedicatedHostPrepaid instance onto postpaid dedicated host is not allowed.The error message returned because subscription instances cannot be deployed on pay-as-you-go dedicated hosts.
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorize.The error message returned because you are not authorized to use the specified instance type.
400DedicatedHostType.UnmatchedThe specified DedicatedHostType doesn?t match the instance type.The error message returned because the specified dedicated host type does not correspond to the specified instance type.
400MissingParameterThe input parameter ImageId that is mandatory for processing this request is not supplied.The error message returned because the required ImageId parameter is not specified.
400MissingParameterThe input parameter InstanceType that is mandatory for processing this request is not supplied.The error message returned because the InstanceType parameter is not specified.
400InvalidParam.NetworkInterface%sThe error message returned because a specified parameter is invalid. Check whether the parameter corresponds to the operation.
400InvalidParameter.CreditSpecificationThe specified CreditSpecification is not supported in this region.The error message returned because the specified credit specification is not supported in this region.
400IncorrectVpcStatusCurrent VPC status does not support this operation.The error message returned because the operation is not supported while the VPC is in the current state.
400InvalidInstanceType.NotSupportedThe specified instanceType is not supported by the deployment set.The error message returned because the specified instance type is not supported by the deployment set. Try another instance type.
400InvalidVpcZone.NotSupportedThe specified operation is not allowed in the zone to which your VPC belongs, please try in other zones.The error message returned because the specified region does not support the specified operation. Try another region.
400IncorrectDefaultVpcStatusThe status of the default VPC is invalid.The error message returned because the state of the default VPC is invalid.
400InvalidAutoRenewPeriod.ValueNotSupportedThe specified autoRenewPeriod is invalid.The error message returned because the specified AutoRenewPeriod parameter is invalid.
400InvalidMarketImageChargeType.NotSupportThe specified chargeType of marketImage is unsupported.The error message returned because the billing method of the Alibaba Cloud Marketplace image is not supported.
400InvalidPeriodType.ValueNotSupportedThe specified parameter PeriodType is invalid.The error message returned because the specified PeriodType parameter is invalid.
400OperationDeniedThe current user does not support this operation.The error message returned because your account does not support the operation.
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType does not exist or beyond the permitted range.The error message returned because the specified instance type does not exist or because you are not authorized to manage instances of the specified instance type.
400InvalidParam.TenancyThe specified Tenancy is invalid.The error message returned because the specified Tenancy parameter is invalid.
400IncorrectVpcStatusThe current status of vpc does not support this operation.The error message returned because the operation is not supported while the VPC is in the current state.
400InvalidParameter.EncryptedIllegalThe specified parameter Encrypted must be true when kmsKeyId is not empty.The error message returned because the encryption feature is not enabled after a KMS key ID is specified.
400IoOptimized.NotSupportedThe specified instance must be IoOptimized instance when kmsKeyId is not empty.The error message returned because I/O optimized instances must be used after the KMSKeyId parameter is specified.
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The error message returned because the specified tag key already exists. Tag keys must be unique.
400JoinedGroupLimitExceed%sThe error message returned because the maximum number of security groups to which the specified resource can be assigned has been exceeded. For more information, see the return value of the %s placeholder in the error message.
400InvalidHttpEndpoint.NotSupportedThe specified HttpEndpoint not supported, you can use enabled(default) or disabled.The error message returned because the specified HttpEndpoint parameter is invalid. The valid values of this parameter are enabled and disabled. The default value is enabled.
400InvalidHttpTokens.NotSupportedThe specified HttpTokens not supported, you can use optional(default) or required.The error message returned because the specified HttpTokens parameter is invalid. The valid values of this parameter are optional and required. The default value is optional.
400InvalidHttpPutResponseHopLimit.NotSupportedThe specified HttpPutResponseHopLimit not supported, more than 1 and less than 64 is reasonable.The error message returned because the specified HttpPutResponseHopLimit parameter is invalid. The valid values of this parameter are 1 to 64.
400InvalidOperation.VpcHasEnabledAdvancedNetworkFeatureThe specified vpc has enabled advanced network feature.The error message returned because advanced features are enabled for the specified VPC. You cannot create low-specification instances in the VPC.
400MissingParameter.PrivatePoolOptionsIdThe specified PrivatePoolOptions.Id should not be null.The error message returned because the PrivatePoolOptions.Id parameter is not specified.
400Invalid.PrivatePoolOptionsIdThe specified PrivatePoolOptions.Id is invalid.The error message returned because the specified PrivatePoolOptions.Id parameter is invalid.
400Invalid.PrivatePoolOptionsIdThe parameter PrivatePoolOptions.Id should be null when PrivatePoolOptions.MatchCriteria is not Target.The error message returned because the PrivatePoolOptions.Id parameter is specified when the PrivatePoolOptions.MatchCriteria parameter is not set to Target.
400DedicatedHostNotSupportedDedicatedHost is not supported for PrivatePool.The error message returned because private pools cannot be used to create instances on dedicated hosts.
400SpotNotSupportedSpot is not supported for PrivatePool.The error message returned because private pools cannot be used to create preemptible instances.
400ClassicNetworkNotSupportedClassic network is not supported for PrivatePool.The error message returned because private pools cannot be used to create instances in the classic network.
400Invalid.InstanceIdInstance does not exist.The error message returned because the specified instance does not exist.
400Invalid.PrivatePoolOptions.MatchCriteriaTarget mode does not support this operation.The error message returned because the operation is not supported while the PrivatePoolOptions.MatchCriteria parameter is set to Target.
400MissingParameter.PrivatePoolOptions.IdThe specified PrivatePoolOptions.Id should not be null.The error message returned because the PrivatePoolOptions.Id parameter is not specified.
400Invalid.PrivatePoolOptions.IdThe PrivatePool does not exist.The error message returned because the private pool does not exist.
400Invalid.InstanceTypeThe InstanceType does not match the PrivatePool.The error message returned because the specified instance type does not match the specified private pool.
400Invalid.InstanceChargeTypeThe InstanceChargeType does not match the PrivatePool.The error message returned because the specified billing method of the specified instance does not match the specified private pool.
400Invalid.ZoneIdThe ZoneId does not match the PrivatePool.The error message returned because the specified zone does not match the specified private pool.
400Invalid.PrivatePoolOptions.MatchCriteriaThe PrivatePoolOptions.MatchCriteria does not match the PrivatePool.The error message returned because the specified PrivatePoolOptions.MatchCriteria parameter does not match the private pool.
400InvalidPlatform.ValueNotSupportedThe Platform does not match the PrivatePool.The error message returned because the specified Platform parameter does not match the private pool.
400InvalidAliUidThe PrivatePool does not belong to the user of the Instance.The error message returned because the specified private pool does not belong to the user who attempted to create the instance.
400Invalid.InstanceIdThe Instance dose not attached to a PrivatePool.The error message returned because the instance does not match the private pool.
400NoPermission.SystemTagThe operator is not permission for the system tag.The error message returned because you are not authorized to manage the system tag.
400InvalidDiskCategory.NotSupportedThe specified disk category is not supported.The error message returned because the specified disk category does not support the operation.
401InvalidRamRole.NotEcsRoleThe specified ram role is not authorized for ecs, please check your role policy.The error message returned because the specified RAM role is not granted permissions to use ECS. Check your role policies.
403InvalidParams.InstanceNameExceedThe uniqueSuffix takes three naming places, please shorten your InstanceName.The error message returned because the instance name must be shortened to make space for the incremental suffix added by UniqueSuffix. The incremental suffix is three characters in length.
403InvalidParams.HostnameExceedThe uniqueSuffix takes three naming places, please shorten your Hostname.The error message returned because the instance hostname must be shortened to make space for the incremental suffix added by UniqueSuffix. The incremental suffix is three characters in length.
403ImageNotSubscribedThe specified image has not be subscribed.The error message returned because you have not subscribed to the specified Alibaba Cloud Marketplace image.
403InvalidSystemDiskCategory.ValueUnauthorizedThe disk category is not authorized.The error message returned because you are not authorized to use the specified disk category.
403InvalidSnapshotId.NotReadyThe specified snapshot has not completed yet.The error message returned because the specified snapshot is being created.
403InstanceDiskCategoryLimitExceedThe total size of specified disk category in an instance exceeds.The error message returned because the total size of disks of the specified category exceeds the maximum capacity allowed for an instance.
403InvalidDevice.InUseThe specified device has been occupied.The error message returned because the specified device already has a disk attached.
403ImageRemovedInMarketThe specified market image is not available, Or the specified user defined image includes product code because it is based on an image subscribed from marketplace, and that image in marketplace includeing exact the same product code has been removed.The error message returned because the specified Alibaba Cloud Marketplace image is unavailable, or because the specified custom image contains the product code of the Alibaba Cloud Marketplace image from which the custom image is derived and the Alibaba Cloud Marketplace image was removed from Alibaba Cloud Marketplace.
403CategoryNotSupportedThe specified zone does not offer the specified disk category.The error message returned because the specified disk category is unavailable in the specified zone.
403QuotaExceed.PortableCloudDiskThe quota of portable cloud disk exceeds.The error message returned because the maximum number of removable disks has been reached.
403SecurityGroupInstanceLimitExceedExceeding the allowed amount of instances of a security group.The error message returned because the maximum number of instances in the security group has been reached.
403NodeControllerUnavailableThe Node Controller is temporarily unavailable.The error message returned because the node controller is unavailable.
403RegionUnauthorizedThere is no authority to create instance in the specified region.The error message returned because you are not authorized to create instances in the specified region.
403CategoryNotSupportedThe specified Zone or cluster does not offer the specified disk category.The error message returned because the specified disk category is unavailable in the specified zone or cluster.
403InvalidSnapshotId.NotDataDiskSnapshotThe specified snapshot is system disk snapshot.The error message returned because the specified snapshot is a system disk snapshot.
403CategoryNotSupportedThe specified cluster does not offer the specified disk category.The error message returned because the specified disk category is unavailable in the specified cluster.
403ForbbidenUser not authorized to operate on the specified resource.The error message returned because you are not authorized to perform operations on the specified resource.
403DeleteWithInstance.ConflictThe specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute.The error message returned because the specified disk is not removable and cannot be released together with the instance.
403InstanceDiskNumLimitExceedThe number of specified disk in an instance exceeds.The error message returned because the number of specified disks exceeds the upper limit for an instance.
403IoOptimized.NotSupportedThe specified image is not support IoOptimized Instance.The error message returned because the specified image does not support I/O optimized instances.
403InvalidDiskSize.TooSmallSpecified disk size is less than the size of snapshot.The error message returned because the specified disk size is smaller than the snapshot size.
403InvalidDiskCategory.MismatchThe specified disk categories combination is not supported.The error message returned because the combination of the specified disk categories is not supported.
403IoOptimized.NotSupportedVpc is not support IoOptimized instance.The error message returned because the VPC does not support I/O optimized instances.
403InvalidDiskCategory.NotSupportedThe specified disk category is not support the specified instance type.The error message returned because the specified disk category does not support the instance type.
403InvalidResourceId.NotSupportedThe specified ResourceId does not support tagging.The error message returned because the specified resource does not support tagging.
403OperationDeniedThe specified RegionId does not support the creation of the network type ECS instance.The error message returned because instances of the specified network type cannot be created in the specified region. Check whether instance resources of this network type are available in the region.
403OperationDenied.ImageNotValidThe specified Image is disabled or is deleted.The error message returned because the specified ImageId parameter does not exist.
403OperationDenied.SnapshotNotValidThe specified snapshot is not allowed to create disk.The error message returned because the specified snapshot cannot be used to create disks.
403OperationDenied.SnapshotNotAllowedThe specified snapshot is not allowed to create disk.The error message returned because the specified snapshot cannot be used to create disks.
403OperationDenied.ZoneNotAllowedThe creation of Instance to the specified Zone is not allowed.The error message returned because instances cannot be created in the specified zone.
403OperationDenied.ZoneSystemCategoryNotMatchThe specified Zone or cluster does not offer the specified disk category or the speicified zone and cluster do not match.The error message returned because the specified disk category is unavailable in the specified zone or cluster or because the specified zone and cluster do not correspond to each other.
403OperationDenied.ResourceControlThe specified region is in resource control, please try later.The error message returned because the specified region is under resource control. Try again later.
403OperationDenied.NoStockThe resource is out of usage.The error message returned because the instance is not in the Running state. Start the instance or check whether the specified operation is not supported.
403OperationDenied.SnapshotParamsNotValidThe capacity of snapshot exceeds the size limit of the specified disk category or the specified category is not authorizied.The error message returned because the maximum snapshot size has been reached or because you are not authorized to use the specified disk category.
403Zone.NotOpenThe specified zone is not granted to you to buy resources yet.The error message returned because you are not authorized to purchase resources in the specified zone.
403Zone.NotOnSaleThe resource in the specified zone is no longer available for sale. Please try other regions and zones.The error message returned because the specified resource is unavailable in the specified zone. Try another resource type or select another region or zone.
403InvalidClusterId.NotFoundThe specified clusterId does not exist.The error message returned because the specified cluster ID does not exist.
403OperationDenied.NoStockThe resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.The error message returned because the specified resource is unavailable in the specified zone. Try another resource type or select another region or zone.
403InvalidInstanceType.ZoneNotSupportedThe specified zone does not support this instancetype.The error message returned because the specified instance type is not supported in the specified zone.
403InstanceType.Offline%sThe error message returned because the operation is not supported while the instance type is retired or while resources of the instance type are insufficient.
403DependencyViolation.WindowsInstanceThe instance creating is window, cannot use ssh key pair to login.The error message returned because the specified instance is a Windows instance and does not support logons using SSH key pairs.
403InvalidUser.PassRoleForbiddenThe RAM user does not have the privilege to pass a RAM role.The error message returned because the RAM user is not authorized to pass a RAM role.
403Forbidden.RiskControlThis operation is forbidden by Aliyun RiskControl system.The error message returned because the operation is forbidden by the risk control system.
403InvalidInstance.UnPaidOrderThe specified Instance has unpaid order.The error message returned because you have unpaid orders for the specified instance. Pay for the orders and try again.
403RealNameAuthenticationErrorYour account has not passed the real-name authentication yet.The error message returned because you have not completed real-name verification. Complete real-name verification and try again.
403InvalidInstanceType.NotSupportedThe specified InstanceType is not Supported.The error message returned because the specified InstanceType parameter is invalid.
403InvalidPayMethodThe specified pay method is not valid.The error message returned because the specified payment method is invalid.
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.The error message returned because your account balance is insufficient. Add funds to your account and try again.
403ImageNotSupportInstanceTypeThe specified image does not support the specified InstanceType.The error message returned because the specified image does not support the specified instance type.
403OperationDenied.InvalidNetworkType%sThe error message returned because the operation is not supported by the specified network type.
403InvalidSpotInterruptionBehavior.ClassicNetworkNotSupportThe specified SpotInterruptionBehavior does not support Classic network Instance.The error message returned because the operation is not supported by instances in the classic network.
403InvalidSpotInterruptionBehavior.LocalDiskNotSupportThe specified SpotInterruptionBehavior does not support local disk instance.The error message returned because the operation is not supported by instances that use local disks.
403OperationDenied.ImageNotValid%sThe error message returned because the image does not support the operation.
403QuotaExceed.PostPaidDiskLiving postPaid disks quota exceeded.The error message returned because the maximum number of pay-as-you-go disks has been reached.
403InvalidParameter.NotMatch%sThe error message returned because a specified parameter is invalid. Check whether parameter conflicts exist.
403OperationDenied.LocalDiskUnsupportedThe configuration change is not allowed when the specified instance has local disks mounted.The error message returned because the instance types of instances that use local disks cannot be changed.
403OperationDenied.InconsistentNetworkThe specified security group and vswitch are not in the same vpc.The error message returned because the specified security group and vSwitch do not belong to the same VPC.
403OperationDeniedIf the network segment of the vswitch is the same as that of its VPC. Therefore, the VPC cannot create other vswitchs across the region.The error message returned because the VPC and vSwitch have the same CIDR block and no additional vSwitches can be created for zones in the VPC.
403DefaultVswitch.ExistedThe default vswitch for VPC already exists.The error message returned because a default vSwitch already exists in the current VPC.
403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.The error message returned because the requested resources are unavailable in the specified zone. Try another instance type or zone. You can call the DescribeZones operation to query available resources.
403IncorrectInstanceStatusThe current status of the resource does not support this operation.The error message returned because the operation is not supported while the resource is in the current state.
403CategoryViolationThe specified instance does not support this operation because of its disk category.The error message returned because the configurations of instances that use local disks cannot be changed.
403ResourcesNotInSameZoneThe specified instance and dedicated host are not in the same zone.The error message returned because the specified instance and dedicated host are not located in the same region.
403InvalidDisk.SystemDiskSizeThe specified SystemDiskSize beyond the permitted range.The error message returned because the specified system disk size exceeds the upper limit.
403InsufficientBalanceYour account does not have enough balance.The error message returned because your account balance is insufficient. Add funds to your account and try again.
403MaxEniIpv6IpsCountExceeded%sThe error message returned because the maximum number of IPv6 addresses that can be assigned to the ENI has been reached.
403InvalidIp.IpRepeated%sThe error message returned because the specified IP address already exists.
403InvalidIp.IpAssigned%sThe error message returned because the specified IP address is already assigned.
403InvalidOperation.Ipv4CountExceeded%sThe error message returned because the maximum number of IPv4 addresses has been reached.
403InvalidOperation.Ipv6CountExceeded%sThe error message returned because the maximum number of IPv6 addresses has been reached.
403InvalidOperation.Ipv6NotSupport%sThe error message returned because IPv6 addresses do not support this operation.
403InvalidVSwitch.Ipv6NotTurnOn%sThe error message returned because the IPv6 feature is not enabled for your current vSwitch. Enable the feature and try again.
403InvalidParam.Amount%sThe error message returned because the specified Amount parameter is invalid.
403InvalidVSwitchId.IpInvalid%sThe error message returned because the specified private IP address is invalid.
403Forbidden.RegionId%sThe error message returned because the service is unavailable in the current region.
403InvalidRegion.NotSupportThe specified region does not support byok.The error message returned because the Bring Your Own Key (BYOK) feature is not supported in the specified region.
403UserNotInTheWhiteListThe user is not in byok white list.The error message returned because you are not authorized to use the BYOK feature. Try again when you are authorized.
403InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The error message returned because the customer master key (CMK) is not enabled when a KMS key ID is specified for a disk. You can call the DescribeKey operation of KMS to query the information about the specified CMK.
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.The error message returned because ECS is not authorized to access your KMS resources.
403SecurityRisk.3DVerificationWe have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email.The error message returned because risks are detected in your default credit card or debit card. Click the URL in the email for verification.
403QuotaExceed.Tags%sThe error message returned because the number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
403QuotaExceed.ElasticQuotaNo additional quota is available for the specified ECS instance type.The error message returned because the maximum number of instances of the specified instance type in the region has been reached. Try another region or instance type, or reduce the purchase quantity. You can go to the ECS console or the Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type.Please sign-on to Alibaba Cloud Console, and submit a quota increase application.The error message returned because the number of instances of the specified instance type exceeds the instance quota. Log on to the ECS console and request a quota increase.
403QuotaExceed.ElasticQuotaThe number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.Please sign-on to Alibaba Cloud Console, and submit a quota increase application.The error message returned because the number of vCPUs allocated to the instance type exceeds the vCPU quota for the instance type. Log on to the ECS console and request a quota increase.
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type, or the number of vCPUs assigned to the ECS instances has exceeded the quota in the zone. Please go to submit a quota increase application.The error message returned because the number of instances or the number of vCPUs exceeds the quota for the specified instance type. Log on to the ECS console and request a quota increase.
403InvalidOperation.ResourceManagedByCloudProduct%sThe error message returned because security groups managed by cloud services cannot be modified.
403InvalidParameter.InvalidEniQueueNumber%sThe error message returned because the specified NetworkInterfaceQueueNumber parameter is invalid. For more information, see the return value of the %s placeholder in the error message.
403InvalidOperation.MaxEniQueueNumberExceeded%sThe error message returned because the maximum number of queues per ENI has been reached. For more information, see the return value of the %s placeholder in the error message.
403InvalidOperation.ExceedInstanceTypeQueueNumber%sThe error message returned because the maximum number of queues for all ENIs on an instance has been reached. For more information, see the return value of the %s placeholder in the error message.
404InvalidSecurityGroupIdThe specified SecurityGroupId is invalid or does not exist.The error message returned because the specified security group ID is invalid or does not exist.
404InvalidClusterId.NotFoundThe ClusterId provided does not exist in our records.The error message returned because the specified cluster ID does not exist.
404InvalidVSwitchId.NotFoundSpecified virtual switch does not exist.The error message returned because the specified vSwitch ID does not exist.
404InvalidVSwitchId.NotFound%sThe error message returned because the specified vSwitch does not exist.
404InvalidImageId.NotFoundThe specified ImageId does not exist.The error message returned because the specified image does not exist within this account. Check whether the image ID is correct.
404InvalidInstanceChargeType.NotFoundThe InstanceChargeType does not exist in our records.The error message returned because the specified instance billing method does not exist.
404DependencyViolation.IoOptimizedThe specified instancetype must be IoOptimized instance.The error message returned because the specified instance type is not I/O optimized.
404PaymentMethodNotFoundNo payment method has been registered on the account.The error message returned because you have not configured a payment method for your account.
404InvalidSystemDiskSize.LessThanImageSizeThe specified parameter SystemDisk.Size is less than the image size.The error message returned because the specified system disk size is smaller than the image size.
404InvalidSystemDiskSize.LessThanMinSizeThe specified parameter SystemDisk.Size is less than the min size.The error message returned because the specified system disk size is smaller than the minimum allowable size.
404InvalidSystemDiskSize.MoreThanMaxSizeThe specified parameter SystemDisk.Size is more than the max size.The error message returned because the specified system disk size exceeds the upper limit.
404InvalidZoneId.NotFoundThe specified zoneId does not exist.The error message returned because the specified ZoneId parameter does not exist.
404InvalidKeyPairName.NotFoundThe specified parameter KeyPairName does not exist in our records.The error message returned when the specified KeyPairName parameter does not exist.
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The error message returned because the specified resource group does not exist.
404InvalidLaunchTemplate.NotFound%sThe error message returned because the specified launch template does not exist. Check whether the parameter value is correct.
404InvalidLaunchTemplateVersion.NotFound%sThe error message returned because the specified launch template of the specified version does not exist. Check whether the parameter values are correct.
404InvalidVSwitchId.NotExist%sThe error message returned because the specified vSwitch does not exist.
404InvalidMarketImage.NotFoundThe specified marketplace image does not exist, please change the imageId and try again.The error message returned because the specified Alibaba Cloud Marketplace image does not exist. Modify the ImageId parameter value and try again later.
404DeploymentSet.NotFoundThe specified deployment set does not exist.The error message returned because the specified deployment set does not exist.
404InvalidParameter.KMSKeyId.NotFoundThe specified KMSKeyId does not exist.The error message returned because the specified KMS key ID does not exist.
404InvalidSecurityGroupId.NotFound%sThe error message returned because the specified security group ID does not exist.
404InvalidDiskIds.NotPortableThe specified DiskId is not portable.The error message returned because the specified disk is not removable.
500InternalErrorThe request processing has failed due to some unknown error.The error message returned because an internal error has occurred. Try again later.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.The error message returned because an internal error has occurred. Try again later.
500InvalidAccount.NotSupportSpotAccording to business rules, this account cannot purchase ECS Spot instances.The error message returned because you cannot purchase preemptible instances in this account based on business rules.

For a list of error codes, see Service error codes.