All Products
Search
Document Center

Elastic Compute Service:RunInstances

更新時間:Nov 14, 2024

Creates pay-as-you-go or subscription Elastic Compute Service (ECS) instances. This operation provides a wide array of features and functions and helps simplify the procedure to create and manage ECS instances. When you call this operation, you can choose to create multiple ECS instances at a time, automatically start the instances, and assign public IP addresses to them. You can also use the features provided by the operation, such as configuring an automatic release time for instances, using a launch template, and configuring custom CPU options, to customize instance configurations for better management of instances.

Operation description

Before you call this operation, familiarize yourself with the billing and pricing of ECS resources.

This operation is an asynchronous operation. After a request to create ECS instances is sent, ECS instance IDs are returned but the creation and startup of the instances may be incomplete. You can call the DescribeInstanceStatus operation to query the status of the instances. When the status of an instance is Running in the DescribeInstanceStatus response, the instance is created and started.

Instructions

  • Make sure that the number of ECS instances you create or the number of vCPUs on ECS instances of all instance types you create does not exceed the corresponding quota. Go to the Quota Center to view the quotas.
  • Before you create ECS instances of the Virtual Private Cloud (VPC) type in a region, create a VPC in the region. For more information, see Create a VPC.

Considerations

  • You can call the RunInstances operation to create up to 100 ECS instances at a time. To create more than 100 ECS instances, we recommend that you initiate multiple requests in batches or concurrently.
  • If you set InternetMaxBandwidthOut to a value greater than 0, public IP addresses are automatically assigned to the ECS instances to be created.
Note Starting November 27, 2020, when you create ECS instances or change ECS instance configurations, the maximum bandwidth value that you can specify is subject to the throttling policy of your account. To increase the maximum bandwidth value, submit a ticket. The throttling policy imposes the following constraints: In a single region, the total maximum bandwidth value of all ECS instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total bandwidth value of all ECS instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.

Suggestions

  • Test scenarios: Set DryRun to true to perform a dry run without performing the actual request.
  • Release of ECS instances: Use AutoReleaseTime to configure an automatic release time for ECS instances in the request to RunInstances or call the DeleteInstances operation to release the instances.
  • Management and search of ECS instances: Add tags to the ECS instances by specifying Tag.N.Key and Tag.N.Value and append incremental suffixes by specifying UniqueSuffix to the hostname specified by HostName and the instance name specified by InstanceName. For more information, see Batch configure sequential names or hostnames for multiple instances.
  • Launch template: A launch template contains the parameters required to create an ECS instance so that you do not have to specify the parameters every time you create ECS instances. You can call the CreateLaunchTemplate operation to create a launch template. Then, in the request to RunInstances, you can specify LaunchTemplateId and LaunchTemplateVersion to use the launch template.
  • Disabling of Hyper-Threading (HT): In memory-intensive scenarios, set CpuOptions.ThreadsPerCore to 1 to disable HT and increase the memory-to-vCPU ratio.
  • Enabling of Jumbo Frames: Set NetworkOptions.EnableJumboFrame to true to enable the Jumbo Frames feature when you create ECS instances. For more information, see MTUs .

Sample requests

Use a specific image to create ECS instances of a specific instance type in the China (Hangzhou) region. The instances use disks with a specific capacity as the system disk and data disks and are automatically assigned public IP addresses. The instances have user-defined names and logon passwords. The instances are assigned to a specific security group and connected to a specific vSwitch. Request parameters:

RegionId: Set the region ID to cn-hangzhou, which specifies the China (Hangzhou) region.ImageId: Set the image ID to aliyun_3_x64_20G_alibase_20221102.vhd.
InstanceType: Set the instance type to ecs.g7.large.
SecurityGroupId: Set the security group ID to sg-bp150uqocpf9jj70****.
VSwitchId: Set the vSwitch ID to vsw-bp1qo7s91cbch5i4l****.
SystemDisk.Category: Set the system disk category to cloud_essd, which specifies the Enterprise SSD (ESSD) category.
SystemDisk.Size: Set the system disk size to 40. Unit: GiB.
DataDisk.Category: Set the data disk category to cloud_essd, which specifies the ESSD category.
DataDisk.Size: Set the data disk size to 100. Unit: GiB.
HostName: Set the instance hostname to ECS-test.
Password: Set the logon password to ECS@test1234.
InternetMaxBandwidthOut: Set the outbound public bandwidth to 10. Unit: Mbit/s.

Examples on how to create instances of different types based on the preceding parameters:

Example: Create five subscription ECS instances for which auto-renewal is enabled

Amount: Set the number of ECS instances that you want to create to 5.
InstanceChargeType: Set the billing method to PrePaid, which specifies the subscription billing method.
PeriodUnit: Set the period unit to Month.
Period: Set the subscription period to 1. The unit is specified by PeriodUnit, which is Month in this example.
AutoRenew: Set this parameter to true to enable auto-renewal.
AutoRenewPeriod: Set the renewal period to 1. The unit is specified by PeriodUnit, which is Month in this example.

Example: Create 10 pay-as-you-go ECS instances

Amount: Set the number of ECS instances that you want to create to 10.
InstanceChargeType: Set the billing method to PostPaid, which specifies the pay-as-you-go billing method.
SpotStrategy: Set this parameter to NoSpot, which is the default value and specifies that the instances are created as pay-as-you-go instances.

Example: Create 20 preemptible instances that have a specified bidding policy and a protection period

Amount: Set the number of ECS instances that you want to create to 20.
InstanceChargeType: Set the billing method to PostPaid.
SpotStrategy: Set the bidding policy to SpotAsPriceGo, which specifies that the instances are created as preemptible instances for which the market price at the time of purchase is automatically used as the bid price.
SpotDuration: Set the protection period of the preemptible instances to 1. Unit: hours.

Call the CreateLaunchTemplate operation to create a launch template. Then, use the launch template to create ECS instances in the China (Hangzhou) region. Sample request:

Example: Create 10 ECS instances based on a launch template

RegionId: Set the region ID to cn-hangzhou, which specifies the China (Hangzhou) region.
Amount: Set the number of ECS instances that you want to create to 10.
LaunchTemplateId: Set the launch template ID to lt-bp14xczpoxvb6rre****.
Note If a parameter is specified both in the launch template that you reference in a request and in the instance parameters of the same request, the value specified in the instance parameters takes precedence. For example, if you set InstanceChargeType in the launch template to PrePaid (subscription) and set InstanceChargeType in the instance parameters to PostPaid (pay-as-you-go), the created instances are pay-as-you-go instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:RunInstancescreate
*All Resources
*
  • vpc:IsDefaultVSwitch
  • vpc:IsDefaultVpc
  • vpc:VPC
  • ecs:IsDiskEncrypted
  • ecs:InstanceTypeFamily
  • ecs:InstanceType
  • ecs:ImageOwnerId
  • ecs:ImageSource
  • ecs:NotSpecifySecurityGroupId
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ImageIdstringNo

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

aliyun_2_1903_x64_20G_alibase_20200324.vhd
ImageFamilystringNo

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.

The name must be 2 to 128 characters in length. The name cannot start with a digit, a special character, http://, or https://. The name can contain letters, digits, periods (.), underscores (_), hyphens (-), and colons (:).

Take note of the following items:

  • If you specify ImageId, you cannot specify ImageFamily.
  • If you do not specify ImageId but use LaunchTemplateId or LaunchTemplateName to specify a launch template that has ImageId specified, you cannot specify ImageFamily.
  • If you do not specify ImageId but use LaunchTemplateId or LaunchTemplateName to specify a launch template that does not have ImageId specified, you can specify ImageFamily.
  • If you do not specify ImageId, LaunchTemplateId, or LaunchTemplateName, you can specify ImageFamily.
Note For information about image families that are associated with Alibaba Cloud official images, see Overview of public images.
hangzhou-daily-update
InstanceTypestringNo

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

ecs.g6.large
SecurityGroupIdstringNo

The ID of the security group to which you want to assign the instance. Instances in the same security group can communicate with each other. The maximum number of instances allowed in a security group varies based 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 is the same as the network type of the security group specified by SecurityGroupId. 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 VSwitchId.

If you do not use LaunchTemplateId or LaunchTemplateName to specify a launch template, you must specify a security group ID. 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 in the same request.
  • 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.
sg-bp15ed6xe1yxeycg7****
VSwitchIdstringNo

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 is located. 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.
vsw-bp1s5fnvk4gn2tws0****
InstanceNamestringNo

The name of the ECS instance. The name must be 2 to 128 characters in length and 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. The sequential names can contain brackets ([ ]) and commas (,). For more information, see Batch configure sequential names or hostnames for multiple instances.

k8s-node-[1,4]-alibabacloud
DescriptionstringNo

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

Instance_Description
InternetMaxBandwidthInintegerNo

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 InternetMaxBandwidthIn 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.
10
InternetMaxBandwidthOutintegerNo

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

Default value: 0.

10
HostNamestringNo

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:

k8s-node-[1,4]-ecshost
UniqueSuffixbooleanNo

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
  • false

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.

true
PasswordstringNo

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 If the Password parameter is specified, we recommend that you send requests over HTTPS to prevent password leaks.
EcsV587!
PasswordInheritbooleanNo

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, make sure that you leave the Password parameter empty and the selected image has a preset password.
false
ZoneIdstringNo

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 you specify the VSwitchId parameter, the zone specified by the ZoneId parameter must be the zone where the vSwitch is located. You can also leave the ZoneId parameter empty. Then, the system selects the zone where the specified vSwitch is located.

This parameter is empty by default.

cn-hangzhou-g
InternetChargeTypestringNo

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 bandwidths 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.
PayByTraffic
SystemDisk.SizestringNo

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

  • Basic disk: 20 to 500.

  • ESSD: Valid values vary based on the performance level of the ESSD.

    • PL0 ESSD: 1 to 2048.
    • PL1 ESSD: 20 to 2048.
    • PL2 ESSD: 461 to 2048.
    • PL3 ESSD: 1261 to 2048.
  • ESSD AutoPL disk: 1 to 2048.

  • Other disk categories: 20 to 2048.

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

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

40
SystemDisk.CategorystringNo

The category of the system disk. Valid values:

  • cloud_efficiency: utra disk
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD)
  • cloud: basic disk
  • cloud_auto: ESSD AutoPL disk
  • cloud_essd_entry: ESSD Entry disk
Note The value of this parameter can be cloud_essd_entry only when InstanceType is set to ecs.u1 or ecs.e. ecs.u1 indicates the u1 universal instance family and ecs.e indicates the e economy instance family. For information about the u1 and e instance families, see the u1, universal instance family section in the "Universal instance families" topic and the e, economy instance family section in the "Shared instance families" topic.

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

cloud_ssd
SystemDisk.DiskNamestringNo

The name of the system disk. The name must be 2 to 128 characters in length and support Unicode characters under the Decimal Number category and the categories whose names contain Letter. The name can contain colons (:), underscores (_), periods (.), and hyphens (-).

cloud_ssdSystem
SystemDisk.DescriptionstringNo

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

SystemDisk_Description
SystemDisk.PerformanceLevelstringNo

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 .

PL0
SystemDisk.AutoSnapshotPolicyIdstringNo

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

sp-bp67acfmxazb4p****
IoOptimizedstringNo

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.
optimized
UserDatastringNo

The user data of the instance. You must specify Base64-encoded data. The instance user data cannot exceed 32 KB in size before Base64 encoding.

For information about the limits, formats, and running frequencies of instance user data, see Instance user data.

Note To ensure security, we recommend that you do not use plaintext to pass in confidential information, such as passwords or private keys, as user data. If you need to 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 manner in the instance.
ZWNobyBoZWxsbyBlY3Mh
KeyPairNamestringNo

The name of the key pair.

Note For Windows instances, this parameter is ignored. This parameter is empty by default. The Password parameter takes effect even if the KeyPairName parameter is specified.
KeyPair_Name
RamRoleNamestringNo

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

RAM_Name
AmountintegerNo

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

The number of ECS instances that can be created varies based on the Amount and MinAmount values.

  • If you do not specify MinAmount, the RunInstances operation creates ECS instances based on the Amount value. If the available resources are insufficient to create the desired number of ECS instances, the RunInstances operation returns an error response and no ECS instances are created.

  • If you specify MinAmount, take note of the following items:

    • If the available resources are insufficient to create the minimum number of ECS instances, no ECS instances are created and the RunInstances operation returns an error response.
    • If the available resources are insufficient to create the desired number of ECS instances but are sufficient to create the minimum number of ECS instances, the RunInstances operation uses the available resources to create ECS instances and returns a success response. In this case, the number of ECS instances that can be created is less than the desired number of ECS instances.
    • If the available resources are sufficient to create the desired number of ECS instances, the RunInstances operation uses the available resources to create the desired number of ECS instances and returns a success response.

Default value: 1.

3
MinAmountintegerNo

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

The number of ECS instances that can be created varies based on the Amount and MinAmount values.

  • If you do not specify MinAmount, the RunInstances operation creates ECS instances based on the Amount value. If the available resources are insufficient to create the desired number of ECS instances, the RunInstances operation returns an error response and no ECS instances are created.

  • If you specify MinAmount, take note of the following items:

    • If the available resources are insufficient to create the minimum number of ECS instances, no ECS instances are created and the RunInstances operation returns an error response.
    • If the available resources are insufficient to create the desired number of ECS instances but are sufficient to create the minimum number of ECS instances, the RunInstances operation uses the available resources to create ECS instances and returns a success response. In this case, the number of ECS instances that can be created is less than the desired number of ECS instances.
    • If the available resources are sufficient to create the desired number of ECS instances, the RunInstances operation uses the available resources to create the desired number of ECS instances and returns a success response.
2
AutoReleaseTimestringNo

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 start 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 later than the current time.
2018-01-01T12:05:00Z
SpotStrategystringNo

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.

NoSpot
SpotDurationintegerNo

The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values:

  • 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.
  • 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.

Alibaba Cloud sends an ECS system event to notify you 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify an appropriate protection period based on your business requirements.

1
SpotPriceLimitfloatNo

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.

0.97
SpotInterruptionBehaviorstringNo

The interruption mode of the preemptible instance. Valid values:

  • Terminate: The instance is released.

  • Stop: The instance is stopped in economical mode.

    For information about the economical mode, see Economical mode.

Default value: Terminate.

Terminate
SecurityEnhancementStrategystringNo

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.
Active
ClientTokenstringNo

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

123e4567-e89b-12d3-a456-426655440000
HpcClusterIdstringNo

The ID of the high performance computing (HPC) cluster to which the instance belongs.

This parameter is required when you create instances of a Supper Computing Cluster (SCC) instance type. For information about how to create an HPC cluster, see CreateHpcCluster .

hpc-bp67acfmxazb4p****
DryRunbooleanNo

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.
false
DedicatedHostIdstringNo

The ID of the dedicated host on which to create the instance. Preemptible instances cannot be created on dedicated hosts. If you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are ignored.

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

dh-bp67acfmxazb4p****
LaunchTemplateIdstringNo

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

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

lt-bp1apo0bbbkuy0rj****
LaunchTemplateNamestringNo

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.

LaunchTemplate_Name
LaunchTemplateVersionlongNo

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.

3
ResourceGroupIdstringNo

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

rg-bp67acfmxazb4p****
PeriodintegerNo

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 Week: 1, 2, 3, and 4.
  • Valid values when PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.
1
PeriodUnitstringNo

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

  • Week
  • Month
Month
AutoRenewbooleanNo

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.

true
AutoRenewPeriodintegerNo

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

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

Default value: 1.

1
InstanceChargeTypestringNo

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 your account has sufficient balance or credit. Otherwise, an InvalidPayMethod error is returned.

PrePaid
DeploymentSetIdstringNo

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

ds-bp1brhwhoqinyjd6****
DeploymentSetGroupNointegerNo

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.

1
PrivateIpAddressstringNo

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

Take note of the following items:

  • If PrivateIpAddress 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.

Note The first IP address and last three IP addresses of each vSwitch CIDR block are reserved. You cannot specify the IP addresses. For example, if a vSwitch CIDR block is 192.168.1.0/24, the IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved.
10.1.**.**
CreditSpecificationstringNo

The performance mode of the burstable instance. Valid values:

Standard
Ipv6AddressCountintegerNo

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.
1
NetworkInterfaceQueueNumberintegerNo

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.
8
DeletionProtectionbooleanNo

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 to only pay-as-you-go instances. It can protect instances against manual releases, but not against automatic releases.
false
HibernationOptions.ConfiguredbooleanNo
Note This parameter is in invitational preview and is unavailable.
false
AffinitystringNo

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 available resources of the original dedicated host are insufficient, the instance cannot be started.

Default value: default.

default
TenancystringNo

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.

default
StorageSetIdstringNo

The ID of the storage set.

ss-bp67acfmxazb4p****
StorageSetPartitionNumberintegerNo

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

2
CpuOptions.CoreintegerNo

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

For information about the default value, see Customize CPU options.

2
CpuOptions.ThreadsPerCoreintegerNo

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

  • If CpuOptionsThreadPerCore is set to 1, Hyper-Threading (HT) is disabled.
  • This parameter is applicable only to specific instance types.
2
CpuOptions.NumastringNo

This parameter is no longer used.

1
CpuOptions.TopologyTypestringNo

The CPU topology type of the instance. Valid values:

  • ContinuousCoreToHTMapping: The HT technology allows continuous threads to run on the same core in the CPU topology of the instance.``
  • DiscreteCoreToHTMapping: The HT technology allows discrete threads to run on the same core in the CPU topology of the instance.``

This parameter is empty by default.

Note This parameter is supported only for specific instance families. For more information about the supported instance families, see View and modify the CPU topology.
DiscreteCoreToHTMapping
SecurityOptions.TrustedSystemModestringNo

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 support the trusted system to replace the system disk of the instance.

For more information about the trusted system, see Overview .

vTPM
SecurityOptions.ConfidentialComputingModestringNo

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 Alibaba Cloud Trusted System (vTPM). When you build a confidential computing environment on an instance by using Enclave, 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 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.

Enclave
HttpEndpointstringNo

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

  • enabled
  • disabled

Default value: enabled.

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

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 the modes of accessing instance metadata, see Access mode of instance metadata.
optional
HttpPutResponseHopLimitintegerNo
Note This parameter is not publicly available.
3
PrivatePoolOptions.MatchCriteriastringNo

The type of the private pool to use to create the instance. A private pool is generated after an elasticity assurance or a capacity reservation takes effect. You can select the private pool when you start an instance. 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:

  • A preemptible instance is created.
  • The instance is created in the classic network.
  • The instance is created on a dedicated host.
Open
PrivatePoolOptions.IdstringNo

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.

eap-bp67acfmxazb4****
IspstringNo
Note This parameter is in invitational preview and is unavailable.
null
SchedulerOptions.DedicatedHostClusterIdstringNo

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.

dc-bp12wlf6am0vz9v2****
SecurityGroupIdsarrayNo

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 of the "Limits" topic.

Take note of the following items:

  • You cannot specify both SecurityGroupId and SecurityGroupIds.N in the same request.
  • 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.
stringNo

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 of the "Limits" topic.

Take note of the following items:

  • You cannot specify both SecurityGroupId and SecurityGroupIds.N in the same request.
  • 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.
sg-bp15ed6xe1yxeycg7****
HostNamesarrayNo

The hostname of instance N. You can use this parameter to specify different hostnames for multiple instances.

stringNo

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. It 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 (-).
ecs-host-01
DataDiskarray<object>No

The data disks.

objectNo

Data disk N.

PerformanceLevelstringNo

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. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1 (default): A single ESSD can deliver up to 50000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1000000 random read/write IOPS.

For information about ESSD performance levels, see ESSDs .

PL1
AutoSnapshotPolicyIdstringNo

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

sp-bp67acfmxazb4p****
EncryptedstringNo

Specifies whether to encrypt data disk N. Valid values:

  • true
  • false

Default value: false.

false
DescriptionstringNo

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

DataDisk_Description
SnapshotIdstringNo

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

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

s-bp17441ohwka0yuh****
DevicestringNo

The mount point of data disk N. The mount points are named based on the number of data disks:

  • 1st to 25th data disks: /dev/xvd[b-z].
  • From the 26th data disk on: /dev/xvd[aa-zz]. For example, the 26th data disk is named /dev/xvdaa, the 27th data disk is named /dev/xvdab, and so on.
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 the 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.
/dev/xvdb
SizeintegerNo

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: vary based on the value of DataDisk.N.PerformanceLevel.

    • Valid values when DataDisk.N.PerformanceLevel is set to PL0: 1 to 65536.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL1: 20 to 65536.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL2: 461 to 65536.
    • Valid values when DataDisk.N.PerformanceLevel is set to PL3: 1261 to 65536.
  • Valid values when DataDisk.N.Category is set to cloud: 5 to 2000.

  • Valid values when DiskCategory is set to cloud_auto: 1 to 65536.

  • Valid values when DataDisk.N.Category is set to cloud_essd_entry: 10 to 32768.

Note The value of this parameter must be greater than or equal to the size of the snapshot specified by DataDisk.N.SnapshotId.
2000
DiskNamestringNo

The name of data disk N. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

cloud_ssdData
CategorystringNo

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

  • cloud_essd_entry: ESSD Entry disk

    **

    Note This parameter can be set to cloud_essd_entry only when InstanceType is set to ecs.u1 or ecs.e.

  • elastic_ephemeral_disk_standard: standard elastic ephemeral disk

  • elastic_ephemeral_disk_premium: premium elastic ephemeral disk

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

cloud_ssd
EncryptAlgorithmstringNo
Note This parameter is not publicly available.
aes-256
DeleteWithInstancebooleanNo

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

  • true
  • false

Default value: true.

true
KMSKeyIdstringNo

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

0e478b7a-4262-4802-b8cb-00d3fb40****
StorageClusterIdstringNo

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

dbsc-j5e1sf2vaf5he8m2****
ProvisionedIopslongNo

The provisioned read/write IOPS of the ESSD AutoPL disk to use 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 DataDisk.N.Category to cloud_auto. For more information, see ESSD AutoPL disks.
40000
BurstingEnabledbooleanNo

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

  • true
  • false
Note This parameter is available only if you set DataDisk.N.Category to cloud_auto. For more information, see ESSD AutoPL disks.
false
Arnarray<object>No
Note This parameter is not publicly available.
objectNo
Note This parameter is not publicly available.
RoleTypestringNo
Note This parameter is not publicly available.
null
RolearnstringNo
Note This parameter is not publicly available.
null
AssumeRoleForlongNo
Note This parameter is not publicly available.
0
NetworkInterfacearray<object>No

The information of the elastic network interfaces (ENIs).

objectNo

The information of ENI N.

VSwitchIdstringNo

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

When you specify this parameter, take note of the following items:

  • The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • If you set NetworkInterface.N.InstanceType to Primary, you must specify this parameter. In this case, this parameter is equivalent to VSwitchId. You cannot specify both NetworkInterface.N.VSwitchId and VSwitchId in the same request.
  • If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the VSwitchId value.
vsw-bp67acfmxazb4p****
NetworkInterfaceNamestringNo

The name of ENI N. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

When you specify this parameter, take note of the following items:

  • The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • If you set NetworkInterface.N.InstanceType to Primary, you do not need to specify this parameter.
Network_Name
DescriptionstringNo

The description of ENI N.

When you specify this parameter, take note of the following items:

  • The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • The description must be 2 to 256 characters in length and cannot start with http:// or https://.
  • If you set NetworkInterface.N.InstanceType to Primary, you do not need to specify this parameter.
Network_Description
SecurityGroupIdstringNo

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

When you specify this parameter, take note of the following items:

  • The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • If you set NetworkInterface.N.InstanceType to Primary, you must specify this parameter. In this case, this parameter is equivalent to SecurityGroupId and you cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N.
  • If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.
sg-bp67acfmxazb4p****
PrimaryIpAddressstringNo

The primary IP address to assign to ENI N.

When you specify this parameter, take note of the following items:

  • The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.

    • If the value of N is 1, you can configure a primary or secondary ENI. If you specify this parameter, set Amount to a numeric value greater than 1, and set NetworkInterface.N.InstanceType to Primary, the specified number of instances are created and consecutive primary IP addresses starting from the specified IP address are assigned to the instances. In this case, you cannot attach secondary ENIs to the instances.
    • If you specify this parameter, set Amount to a numeric value greater than 1, and set NetworkInterface.N.InstanceType to Primary, you cannot set NetworkInterface.2.InstanceType to Secondary to attach a secondary ENI.
  • If you set NetworkInterface.N.InstanceType to Primary, this parameter is equivalent to PrivateIpAddress. You cannot specify both this parameter and PrivateIpAddress in the same request.

  • If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType 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
  • The first IP address and last three IP addresses of each vSwitch CIDR block are reserved. You cannot specify the IP addresses. For example, if a vSwitch CIDR block is 192.168.1.0/24, the following IP addresses are reserved: 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255.
172.16.**.**
QueueNumberintegerNo

The number of queues supported by ENI N.

When you specify this parameter, take note of the following items:

  • The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • The value of this parameter cannot exceed the maximum number of queues allowed per ENI.
  • The total number of queues for all ENIs on an 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 and check the MaximumQueueNumberPerEni and TotalEniQueueQuantity values in the response.
  • If you specify this parameter and set NetworkInterface.N.InstanceType to Primary, you cannot specify NetworkInterfaceQueueNumber.
8
SecurityGroupIdsarrayNo

The IDs of security groups to which to assign ENI N.

  • The value of the first N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • The second N indicates that one or more security group IDs can be specified. The valid values of the second 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 of the "Limits" topic.

When you specify this parameter, take note of the following items:

  • If you set NetworkInterface.N.InstanceType to Primary, you must specify 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 you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.
stringNo

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

  • The value of the first N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.
  • The second N indicates that one or more security group IDs can be specified. The valid values of the second 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 of the "Limits" topic.

When you specify this parameter, take note of the following items:

  • If you set NetworkInterface.N.InstanceType to Primary, you must specify 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 you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you do not need to specify this parameter. The default value is the ID of the security group to which to assign the instance.
sg-bp15ed6xe1yxeycg7****
NetworkInterfaceTrafficModestringNo

The communication mode of ENI N. Valid values:

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

Default value: Standard.

Note The number of ERIs on an instance cannot exceed the maximum number of ERIs that the instance type supports. For more information, see Overview of instance families.
Standard
QueuePairNumberlongNo

The number of queues supported by the ERI.

0
InstanceTypestringNo

The type of ENI N. The value of N cannot exceed the maximum number of ENIs per instance that the instance type supports. For the maximum number of ENIs per instance that an instance type supports, see Overview of instance families or call the DescribeInstanceTypes operation.

Valid values:

  • Primary: the primary ENI
  • Secondary: the secondary ENI

Default value: Secondary.

Secondary
Ipv6AddressCountlongNo

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

When you specify this parameter, take note of the following items:

  • This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter.
  • If you specify this parameter, you cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6Address.N.
1
Ipv6AddressarrayNo

The IPv6 addresses to assign to the primary ENI. You can assign up to 10 IPv6 addresses to the primary ENI. Valid values of the second N: 1 to 10.

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

When you specify this parameter, take note of the following items:

  • This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter.
  • If you specify this parameter, you must set Amount to 1 and cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6AddressCount.
stringNo

IPv6 address N to assign to the primary ENI. You can assign up to 10 IPv6 addresses to the primary ENI. Valid values of the second N: 1 to 10.

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

When you specify this parameter, take note of the following items:

  • This parameter is valid only when NetworkInterface.N.InstanceType is set to Primary. If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you cannot specify this parameter.
  • If you specify this parameter, you must set Amount to 1 and cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6AddressCount.
2001:db8:1234:1a00::***
NetworkCardIndexintegerNo

The index of the network card for ENI N.

When you specify this parameter, take note of the following items:

  • You can specify NIC indexes only for instances of specific instance types.
  • If you set NetworkInterface.N.InstanceType to Primary, you can set NetworkInterface.N.NetworkCardIndex only to 0 for instance types that support network cards.
  • If you set NetworkInterface.N.InstanceType to Secondary or leave NetworkInterface.N.InstanceType empty, you can specify NetworkInterface.N.NetworkCardIndex based on instance types if the instance types support network cards. For more information, see Overview of instance families.
0
DeleteOnReleasebooleanNo

Specifies whether to release ENI N when the associated instance is released. Valid values:

  • true: releases the ENI when the associated instance is released.
  • false: retains the ENI when the associated instance is released.

Default value: true.

Note This parameter takes effect only for secondary ENIs.
true
NetworkInterfaceIdstringNo

The ID of ENI N to attach to the instance.

Note This parameter takes effect only for secondary ENIs. After you specify an existing secondary ENI, you cannot specify other ENI creation parameters.
eni-bp1gn106np8jhxhj****
RxQueueSizeintegerNo

The receive (Rx) queue depth of ENI N.

When you specify this parameter, take note of the following items:

  • The Rx queue depth of an ENI must be the same as the transmit (Tx) queue depth of the ENI. Valid values: powers of 2 in the range of 8192 to 16384.
  • A larger Rx queue depth yields higher inbound throughput but consumes more memory.
8192
TxQueueSizeintegerNo

The Tx queue depth of ENI N.

When you specify this parameter, take note of the following items:

  • The Tx queue depth of an ENI must be the same as the Rx queue depth of the ENI. Valid values: powers of 2 in the range of 8192 to 16384.
  • A larger Tx queue depth yields higher outbound throughput but consumes more memory.
8192
Tagarray<object>No

The tags to add to the instance, disks, and primary ENI.

objectNo
KeystringNo

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. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.

TestKey
ValuestringNo

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. The tag value can be up to 128 characters in length and cannot contain http:// or https://.

TestValue
Ipv6AddressarrayNo

IPv6 address N to be assigned 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 and must set NetworkInterface.N.Ipv6Addresses.N or NetworkInterface.N.Ipv6AddressCount.
stringNo

IPv6 address N to be assigned 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 and must set NetworkInterface.N.Ipv6Addresses.N or NetworkInterface.N.Ipv6AddressCount.
2001:db8:1234:1a00::***
SystemDiskobjectNo

The parameters related to the system disk. You can use StorageClusterId to specify the ID of a dedicated block storage cluster.

StorageClusterIdstringNo

The ID of the dedicated block storage cluster to which the system disk belongs. If you want to use disks in a dedicated block storage cluster as system disks when you create instances, specify this parameter.

dbsc-j5e1sf2vaf5he8m2****
ProvisionedIopslongNo

The provisioned read/write IOPS of the ESSD AutoPL disk to use as the system disk. 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 SystemDisk.Category to cloud_auto. For more information, see ESSD AutoPL disks.
40000
BurstingEnabledbooleanNo

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

  • true: enables the performance burst feature for the system disk.
  • false: disables the performance burst feature for the system disk.
Note This parameter is available only if you set SystemDisk.Category to cloud_auto. For more information, see ESSD AutoPL disks.
false
EncryptedstringNo

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.
false
KMSKeyIdstringNo

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

0e478b7a-4262-4802-b8cb-00d3fb40****
EncryptAlgorithmstringNo
Note This parameter is not publicly available.
ase-256
ImageOptionsobjectNo

Details about the image options.

LoginAsNonRootbooleanNo

Specifies whether the instance that uses the image supports logons of the ecs-user user. Valid values:

  • true
  • false
false
NetworkOptionsobjectNo

Details about network options.

EnableJumboFramebooleanNo

Specifies whether to enable the Jumbo Frames feature for the instance. Valid values:

  • false: does not enable the Jumbo Frames feature for the instance. The maximum transmission unit (MTU) value of all ENIs on the instance is set to 1500.
  • true: enables the Jumbo Frames feature for the instance. The MTU value of all ENIs on the instance is set to 8500.

Default value: true.

Note The Jumbo Frames feature is supported by only 8th-generation or later instance types. For more information, see MTUs .
false
AutoPaybooleanNo

Specifies whether to automatically complete the payment for instance creation. Valid values:

  • true: The payment is automatically completed.

    **

    Note Make sure that your account balance is sufficient. Otherwise, your order becomes invalid and is canceled. If your account balance is insufficient, you can set AutoPay to false to generate an unpaid order. Then, you can log on to the ECS console to pay for the order.

  • false: An order is generated but no payment is made.

    **

    Note When InstanceChargeType is set to PostPaid, AutoPay cannot be set to false.

Default value: true.

true
PrivateDnsNameOptionsobjectNo
Note This parameter is in invitational preview and is not publicly available.
EnableInstanceIdDnsARecordbooleanNo
Note This parameter is in invitational preview and is not publicly available.
false
EnableInstanceIdDnsAAAARecordbooleanNo
Note This parameter is in invitational preview and is not publicly available.
true
EnableIpDnsARecordbooleanNo
Note This parameter is in invitational preview and is not publicly available.
true
EnableIpDnsPtrRecordbooleanNo
Note This parameter is in invitational preview and is not publicly available.
false
HostnameTypestringNo
Note This parameter is in invitational preview and is not publicly available.
Custom

Response parameters

ParameterTypeDescriptionExample
object

The information about the created instances.

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OrderIdstring

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

123456****
TradePricefloat

The transaction price.

0.165
InstanceIdSetsarray

The IDs of the instances (InstanceIdSet).

InstanceIdSetstring

The IDs of the instances (InstanceIdSet).

["i-bp67acfmxazb4pd2****", "i-bp1i43l28m7u48p1****", "i-bp12yqg7jdyxl11f****"]

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400LoginAsNonRoot.ImageNotSupportThe specified image does not support login as non-root.The image does not support the logons of non-root users.
400InvalidParam.NotSupportJumboFrameNot support jumbo frame.-
400InsufficientBalance.AgentCreditInsufficient agent credit. Please contact your agent.Your credit balance is insufficient. Contact your agent for an adjustment.
400QuotaExceed.DiskCapacityThe used capacity of disk type has exceeded the quota in the zone, %s.The capacity of disks that belong to the specified disk category exceeds the quota limit for the zone.
400InvalidPeriod.ExceededDedicatedHostInstance expired date can not exceed dedicated host expired date.The expiration date of the instance is later than that of the dedicated host.
400InvalidParam.SecondaryNetworkInterfaceWhen min amount greater than 1 and the PrivateIpAddress or Primary NetworkInterface is specified,the Secondary NetworkInterface IP parameter cannot be specified.-
400InvalidPrimaryIpAddress.SizeInvalidThe NetworkInterface PrimaryIpAddress is used to create only one instance.-
400InvalidStorageClusterId.CapacityNotEnoughThe remaining capacity of the current dedicated storage cluster is less than the size of disk.The remaining capacity of the dedicated block storage cluster to which the disk belongs is insufficient.
400InvalidStorageClusterId.StatusNotSupportThe current status of the dedicated storage cluster cannot create a cloud disk yet.-
400InvalidStorageClusterId.ZoneIdEmptyThe specified param ZoneId cannot be empty when StorageClusterId given.-
400InvalidStorageClusterId.PerformanceLevelNotMatchThe current dedicated storage cluster cannot create this performance level of disk.-
400InvalidStorageClusterId.CategoryNotMatchThe current dedicated storage cluster cannot create this category of disk.-
400InvalidStorageClusterId.DiskSizeEmptyThe specified param DiskSize cannot be empty when StorageClusterId given.-
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.You are not authorized to use the specified instance type.
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType beyond the permitted range.-
400InvalidDescription.MalformedThe specified parameter "Description" is not valid.The source description can be 2 to 256 characters in length. It cannot start with http:// and https://.
400InvalidInternetChargeType.ValueNotSupportedThe specified InternetChargeType is not valid.The specified InternetChargeType parameter is invalid.
400InvalidParameterThe specified parameter "InternetMaxBandwidthOut" is not valid.-
400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
400InvalidPassword.MalformedThe specified parameter "Password" is not valid.-
400InvalidPasswordParam.MismatchThe input password should be null when passwdInherit is true.The Password parameter must be left empty when the PasswdInherit parameter is used.
400InvalidSystemDiskCategory.ValueNotSupportedThe specified parameter "SystemDisk.Category" is not valid.-
400InvalidDiskName.MalformedThe specified parameter "SyatemDisk.DiskName or DataDisk.n.DiskName" is not valid.-
400InvalidDiskDescription.MalformedThe specified parameter "SyatemDisk.DiskDescription" or "DataDisk.n.Description" is not valid.-
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 specified DataDisk.N.Size parameter is invalid or the snapshot size exceeds the maximum capacity allowed for the specified disk category.
400InvalidDataDiskCategory.ValueNotSupportedThe specified parameter "DataDisk.n.Category" is not valid.-
400InvalidDataDevice.MalformedThe specified parameter "DataDisk.n.Device" is not valid.-
400InvalidNodeControllerId.MalformedThe specified parameter "NodeControllerId" is not valid.-
400InvalidInnerIpAddress.MalformedThe specified parameter "InnerIpAddress" is not valid.-
400InvalidInnerIpAddress.UnusableThe specified InnerIpAddress is already used or not found in usable ip range.The specified internal IP address is unavailable.
400InvalidParameter.ConflictThe specified image does not support the specified instance type.The specified image cannot be used for instances of the specified instance type.
400ImageNotSupportCloudInitThe specified image does not support cloud-init.-
400InvalidSnapshotId.BasedSnapshotTooOldThe specified snapshot is created before 2013-07-15.The specified snapshot was created before July 15, 2013.
400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.The maximum number of pay-as-you-go instances has been reached.
400InvalidInstanceName.MalformedThe specified parameter "InstanceName" is not valid.The specified InstanceName parameter is invalid.
400InvalidInstanceName.CustomMalformedCustomized section of instance or host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].-
400InvalidDiskDescription.MalformedThe specified parameter "SyatemDisk.DiskDescription or DataDisk.n.Description" is not valid.-
400InvalidParameter.ConflictThe speicified region and cluster do not match.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 specified security group and vSwitch do not belong to the same VPC.
400InvalidNetworkType.MismatchSpecified parameter "InternetMaxBandwidthIn" or "InternetMaxBandwidthOut" conflict with instance network type.-
400InvalidNetworkType.MismatchSpecified parameter "InternetChargeType" conflict with instance network type.-
400InvalidPrivateIpAddressSpecified private IP address is not in the CIDR block of virtual switch.The specified private IP address does not fall within the CIDR block of the specified vSwitch.
400InvalidPrivateIpAddress.MalformedSpecified private IP address is malformed.The specified private IP address is invalid.
400QuotaExceeded.PrivateIpAddressDon't have enough private IPs in this switch.-
400QuotaExceededLiving instances quota exceeded in this VPC.The maximum number of the living instance is exceeded.
400IncorrectVSwitchStatusThe current status of virtual switch does not support this operation.The specified vSwitch is in the Pending state and cannot be deleted.
400InvalidParameter.MismatchSpecified virtual switch is not in the specified zone.The specified vSwitch does not exist in the specified zone.
400ResourceNotAvailableResource you requested is not available in this region or zone.VPC is not supported by the specified region or zone.
400MissingParameterThe input parameter "VSwitchId" that is mandatory for processing this request is not supplied.-
400InvalidDiskCategory.MismatchThe specified disk categories' combination is not supported.-
400MissingParamterThe specified parameter "Period" is not null.-
400InvalidPeriodThe specified period is not valid.The specified period is invalid.
400InvalidDataDiskCategory.ValueNotSupportedThe specified parameter " DataDisk.n.Category " is not valid.-
400InvalidSystemDiskCategory.ValueNotSupportedThe specified parameter " SystemDisk.Category " is not valid.-
400InstanceDiskCategoryLimitExceedThe specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.The specified DataDisk.N.Size parameter is invalid or the snapshot size exceeds the maximum capacity allowed for the specified disk category.
400InvalidInstanceType.ValueNotSupportedInternetMaxBandwidthOut should be set.The InternetMaxBandwidthOut parameter is required.
400InvalidClientToken.ValueNotSupportedThe ClientToken provided is invalid.The specified ClientToken parameter is invalid.
400InvalidIoOptimize.ValueNotSupportedThe specified IoOptimize is not valid.The specified IoOptimized parameter is invalid.
400InvalidSecurityGroupId.NotFoundThe SecurityGroupId provided does not exist in our records.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 specified HostName parameter is invalid.
400InvalidInternetMaxBandwidthOut.MalformedThe specified parameter internetMaxBandwidthOut is not valid.The specified InternetMaxBandwidthOut parameter is invalid.
400InvalidInternetMaxBandwidthIn.MalformedThe specified parameter internetMaxBandwidthIn is not valid.The specified InternetMaxBandwidthIn parameter is invalid.
400InvalidSnapshotId.NotFoundThe specified parameter SnapshotId is not exist.The specified snapshot does not exist. Check whether the snapshot ID is valid.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.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 number of specified tags exceeds the upper limit.
400InvalidMinAmount.MalformedThe specified parameter MinAmount is not valid.The specified MinAmount parameter is invalid.
400InvalidMaxAmount.MalformedThe specified parameter MaxAmount is not valid.The specified MaxAmount parameter is invalid.
400InvalidAutoReleaseTime.MalformedThe specified parameter AutoReleaseTime is not valid.The specified automatic release time is invalid. Specify the time in UTC in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.
400InvalidPrivateIpAddress.MalformedThe specified parameter PrivateIpAddress is not valid.The specified PrivateIpAddress parameter is invalid.
400InvalidInnerIpAddress.MalformedThe specified parameter InnerIpAddress is not valid.The specified InnerIpAddress parameter is invalid.
400OperationDenied.NoVlanThe specified parameter "VlanId" is not valid or vlan has not enough IP address.-
400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.The maximum number of tags on resource is exceeded.
400Account.ArrearageYour account has been in arrears.Your account does not have enough balance. Please add funds to your account.
400InvalidUserData.SizeExceededThe specified parameter "UserData" exceeds the size.-
400InvalidUserData.NotSupportedTThe specified parameter "UserData" only support the vpc and IoOptimized Instance.-
400InvalidUserData.NotSupportedThe specified parameter "UserData" only support the vpc and IoOptimized Instance.-
400InvalidUserData.Base64FormatInvalidThe specified UserData is not valid.The specified user data is invalid.
400InstanceDiskNumber.LimitExceedThe total number of specified disk in an instance exceeds.The number of disks on an instance exceeds the upper limit.
400InvalidDiskCategory.ValueNotSupportedThe specified parameter "DiskCategory" is not valid.-
400InvalidSpotStrategyThe specified SpotStrategy is not valid.The specified SpotStrategy parameter is invalid.
400InvalidSpotParam.EmptyZoneIDThe specified zoneid is empty when SpotStrategy is set.The ZoneId parameter is not specified while the SpotStrategy parameter is specified.
400InvalidSpotPriceLimitThe specified SpotPriceLimitis not valid.The specified SpotPriceLimit parameter is invalid.
400InvalidSpotDurationThe specified SpotDuration is not valid.The specified SpotDuration parameter is invalid.
400InvalidSpotAuthorizedThe specified Spot param is unauthorized.You are not authorized to set the SpotDuration parameter.
400InvalidSpotPrepaidThe specified Spot type is not support PrePay Instance.Preemptible instances do not support the subscription billing method.
400InvalidSpotAliUidThe specified UID is not authorized to use SPOT instance.You are not authorized to create preemptible instances.
400InvalidParameter.Bandwidth%sThe specified bandwidth value is invalid.
400InvalidDataDiskCategory.ValueNotSupported%s-
400InvalidSystemDiskCategory.ValueNotSupported%sThe specified system disk category is invalid.
400InvalidParameter.Conflict%sThe 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 specified InternetChargeType parameter is invalid.
400InvalidInstanceType.ValueNotSupported%sThe operation is not supported by the specified instance type.
400RegionUnauthorized%s-
400Zone.NotOnSale%sThe 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 specified system disk size is invalid.
400InvalidDataDiskSize.ValueNotSupported%s-
400InvalidInstanceType.ValueNotSupportedThe specified parameter "KeyPairName" only support IoOptimized Instance.-
400InvalidInstanceType.ElasticNetworkInterfaceNotSupportedThe specified instance type does not support Elastic Network Interface, you can not attach Elastic Network Interface to generation I instances.The specified instance type does not support ENIs.
400InvalidParameter.EncryptedIllegal%sThe specified parameter is invalid. Check whether your encryption operation is supported. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidParameter.EncryptedNotSupported%sThe specified parameter is invalid and your encryption operation is not supported. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidSpotPriceLimit.LowerThanPublicPriceThe specified parameter "spotPriceLimit" can't be lower than current public price.-
400InvalidRelationResource.NotFoundThe relation resource has been deleted.The associated resource has been deleted.
400IncorrectRecycleBinStatusThe operation is not permitted due to resource status.The resource is in a state that does not support the current operation.
400InvalidHpcClusterId.UnnecessaryThe specified HpcClusterId is unnecessary.The HpcClusterId parameter is specified.
400InvalidVSwitchId.NecessaryThe VSwitchId is necessary.The VSwitchId parameter is required.
400InvalidHpcClusterId.NecessaryThe HpcClusterId is necessary.The HpcClusterId parameter is required.
400InvalidHpcClusterId.NotFoundThe specified HpcClusterId is not found.The specified HpcClusterId parameter does not exist.
400InvalidHpcClusterId.CreatingThe specified HpcClusterId is creating.The specified HPC cluster is being created.
400InvalidParameter.VSwitchId%s-
400InvalidSecurityGroup.NotInDefaultVpc%sThe 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.No VPC is found based on the specified vSwitch or the corresponding VPC does not belong to you.
400InvalidSystemDiskSize.ImageNotSupportResizeThe specified image does not support resize.The specified image does not support resizing.
400InvalidSpotInterruptionBehavior%sThe specified SpotInterruptionBehavior parameter is not supported.
400InvalidDeploymentOnHost%s-
400InvalidInstanceChargeType.NotSupportThe Dedicated host not support the specified Instance charge type.This dedicated host does not support instances that use the specified billing method.
400InvalidNetworkType.NotSupportedThe classic networkType not support create ECS on dedicatedHost.-
400NoAvaliableDedicatedHostNo available dedicated host or not enough resource on dedicated host.-
400InvalidDedicatedHostId.NotFoundThe specified DedicatedHostId does not exist.-
400InvalidDedicatedHostStatus.NotSupportOperation denied due to dedicated host status.-
400IncorrectDedicatedHostStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
400ChargeTypeViolation.PostPaidDedicatedHostPrepaid instance onto postpaid dedicated host is not allowed.-
400InvalidPeriod.ExceededDedicatedHostInstance expired date can't exceed dedicated host expired date.-
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorize.You are not authorized to use the instance type.
400DedicatedHostType.UnmatchedThe specified DedicatedHostType doesn?t match the instance type.-
400NoAvaliableDedicatedHostThere's no enough resource on the specified dedicated host.-
400MissingParameterThe input parameter ImageId that is mandatory for processing this request is not supplied.The ImageId parameter is required.
400MissingParameterThe input parameter InstanceType that is mandatory for processing this request is not supplied.The InstanceType parameter is required.
400InvalidParam.NetworkInterface%sThe specified parameter is invalid. Check whether the parameter corresponds to the operation.
400InvalidParams.CreateEniParams%s-
400InvalidParameter.CreditSpecificationThe specified CreditSpecification is not supported in this region.The running mode of the specified burst performance instance is not supported in this zone.
400IncorrectVpcStatusCurrent VPC status does not support this operation.The VPC is in a state that does not support the current operation.
400InvalidInstanceType.NotSupportedThe specified instanceType is not supported by the deployment set.The current deployment set does not support the specified instance type. Try another instance type.
400InvalidInstanceType.NotSupportedThe specified instanceType is not supported by the image architecture.-
400InvalidVpcZone.NotSupportedThe specified operation is not allowed in the zone to which your VPC belongs, please try in other zones.The specified operation cannot be performed in the region to which the VPC belongs. Try another region.
400IncorrectDefaultVpcStatusThe status of the default VPC is invalid.The state of the default VPC is invalid.
400InvalidAutoRenewPeriod.ValueNotSupportedThe specified autoRenewPeriod is invalid.The specified auto-renewal duration is invalid.
400InvalidMarketImageChargeType.NotSupportThe specified chargeType of marketImage is unsupported.The billing method of the Alibaba Cloud Marketplace image is not supported.
400OperationDeniedThe specified instanceType or zone is not available or not authorized.The specified instance type or zone is unavailable or you are not authorized to use the specified instance type or access the specified zone.
400InvalidPeriodType.ValueNotSupportedThe specified parameter PeriodType is invalid.The specified PeriodType parameter is invalid.
400OperationDeniedThe current user does not support this operation.Your account does not support this operation.
400IncorrectImageStatusThe specified image is an Alibaba Cloud Marketplace image. The sale of this image has ended. For more information, contact the image service provider.The specified image is an Alibaba Cloud Marketplace image that is no longer sold. For more information about the image, contact the image provider.
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType does not exist or beyond the permitted range.The specified instance type does not exist or you are not authorized to manage instances of this instance type.
400NoAvaliableDedicatedHostNo dedicated host is available.-
400InvalidParam.TenancyThe specified Tenancy is invalid.The specified Tenancy parameter is invalid.
400InvalidParameter.AffinityThe specified Affinity is invalid.-
400NoAvaliableDedicatedHostA dedicated host with sufficient available resources cannot be found.-
400InvalidCustomInstanceType.NotSupportedThe specified custom instance type is invalid.-
400IncorrectVpcStatusThe current status of vpc does not support this operation.The VPC is in a state that does not support the current operation.
400InvalidParameter.EncryptedIllegalThe specified parameter Encrypted must be true when kmsKeyId is not empty.The encryption feature is not enabled after a Key Management Service (KMS) key ID is specified.
400IoOptimized.NotSupportedThe specified instance must be IoOptimized instance when kmsKeyId is not empty.The specified instance must be an I/O optimized one when the KMSKeyId parameter is specified.
400InvalidSnapshotId.MalformedThe specified SnapshotId is not valid.-
400InvalidCapacityReservationId.NotFoundThe specified CapacityReservationId does not exist.-
400LackResourceThere's no enough resource on the specified capacity reservation.-
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
400InvalidSecurityGroup.NetworkType%s-
400InvalidSecurityGroup.VpcMismatch%s-
400InvalidParameter.SecurityGroupIdRepeated%s-
400InvalidSecurityGroupId.SingleIdAndMultiIdConflict%s-
400InvalidSecurityGroupId.MultiGroupIdNetworkTypeConflict%s-
400JoinedGroupLimitExceed%sThe maximum number of security groups to which the specified resource can be added has been reached. For more information, see the return value of the %s placeholder in the error message.
400IncorrectVSwitchStatusThe current status of vSwitch does not support this operation.-
400InvalidAccountStatus.PayAmountLimitExceededYour account is being restricted, because you have no default payment method or you are not authorized.-
400InvalidPerformanceLevel.MalformedThe specified parameter DataDisk.n.PerformanceLevel is not valid.-
400InvalidOperation.EniCountExceededThe maximum number of eni in a enterprise security group is exceeded.-
400QuotaExceeded.PrepayDataDiskCapacityThe quota of prepay data disk capacity exceeds.-
400InvalidDiskCategory.ConflictSnapshotCategoryThe specified disk category conflict with snapshot category.-
400AccountForbidden.ProductCreationLimitedThe commodity must be officially operated by Aliyun and in pay-as-you-go billing method.-
400UnexpectedImageFamily.ImageIdSuppliedThe input parameter ImageFamily must be null when image id is set.The ImageFamily parameter must be left empty if an image ID is specified.
400InvalidEncrypted.NotMatchEncryptAlgorithmThe specified parameter Encrypted must be true when EncryptAlgorithm is not empty.-
400InvalidEncrypted.NotMatchKmsKeyIdThe specified parameter Encrypted must be true when KmsKeyId is not empty.-
400InvalidEncrypted.NotMatchSnapshotThe specified parameter Encrypted is different from the Encrypted of the snapshot.-
400InvalidEncryptAlgorithm.NotMatchSnapshotThe specified parameter EncryptAlgorithm is different from the encrypt algorithm of the snapshot.-
400InvalidKmsKeyId.NotMatchSnapshotThe specified parameter KmsKeyId is different from the KmsKeyId of the snapshot.-
400InvalidEncryptAlgorithmThe specified parameter EncryptAlgorithm is not valid.-
400InvalidHttpEndpoint.NotSupportedThe specified HttpEndpoint not supported, you can use enabled(default) or disabled.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 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 specified HttpPutResponseHopLimit parameter is invalid. The valid values of this parameter are 1 to 64.
400InvalidOperation.VpcHasEnabledAdvancedNetworkFeatureThe specified vpc has enabled advanced network feature.Advanced features are enabled for the specified VPC. You cannot create low-specification instances in the VPC.
400InvalidChargeType.CapacityReservationNotSupported%s-
400InvalidPerformanceLevel.ValueNotSupportedThe current ZoneId or InstanceType does not support PL0 of cloud_essd.-
400InvalidKMSKeyId.NotSymmetricThe specified parameter KmsKeyId must be symmetric.-
400InvalidParameter.ArnsThe specified Arns is not valid.-
400InvalidDedicatedHostClusterId.NotFoundThe specified DedicatedHostClusterId does not exist.-
400InvalidDedicatedHostClusterId.InValidThe specified Dedicated Host Cluster is invalid.-
400InvalidDeploymentSetId.NotFoundThe parameter DeploymentSetId is invalid.-
400InvalidOperation.UserNotSupportedReseller user do not support purchase at the moment.-
400InvalidManagedPrivateSpaceId.NotFound%s-
400InvalidSchedulerOptionsThe specified parameter SchedulerOptions is not valid.-
400MissingParameter.PrivatePoolOptionsIdThe specified PrivatePoolOptions.Id should not be null.The PrivatePoolOptions.Id parameter is required.
400Invalid.PrivatePoolOptionsIdThe specified PrivatePoolOptions.Id is invalid.The specified PrivatePoolOptions.Id parameter is invalid.
400Invalid.PrivatePoolOptionsIdThe parameter PrivatePoolOptions.Id should be null when PrivatePoolOptions.MatchCriteria is not Target.The PrivatePoolOptions.Id parameter is specified when the PrivatePoolOptions.MatchCriteria parameter is set to a value other than Target.
400DedicatedHostNotSupportedDedicatedHost is not supported for PrivatePool.The private pool does not support dedicated hosts.
400SpotNotSupportedSpot is not supported for PrivatePool.The private pool does not support preemptible instances.
400ClassicNetworkNotSupportedClassic network is not supported for PrivatePool.The private pool does not support instances in the classic network.
400Invalid.InstanceIdInstance does not exist.The specified instance does not exist.
400Invalid.PrivatePoolOptions.MatchCriteriaTarget mode does not support this operation.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 PrivatePoolOptions.Id parameter is required.
400Invalid.PrivatePoolOptions.IdThe PrivatePool does not exist.The private pool does not exist.
400Invalid.InstanceTypeThe InstanceType does not match the PrivatePool.The instance type and the private pool do not match.
400Invalid.InstanceChargeTypeThe InstanceChargeType does not match the PrivatePool.The instance billing method and the private pool do not match.
400Invalid.ZoneIdThe ZoneId does not match the PrivatePool.The zone and the private pool do not match.
400Invalid.PrivatePoolOptions.NoStockThe PrivatePool has been used up.-
400Invalid.PrivatePoolOptions.MatchCriteriaThe PrivatePoolOptions.MatchCriteria does not match the PrivatePool.The specified PrivatePoolOptions.MatchCriteria parameter does not match the private pool.
400InvalidPlatform.ValueNotSupportedThe Platform does not match the PrivatePool.The specified Platform parameter does not match the private pool.
400Invalid.PrivatePoolOptions.statusThe PrivatePool is expired or inactive.-
400Invalid.PrivatePoolOptions.statusThe PrivatePool status is not valid.-
400Invalid.PrivatePoolOptions.statusThe Instance should be created within 48 hours once the PrivatePool is started.-
400InvalidAliUidThe PrivatePool does not belong to the user of the Instance.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 instance and the private pool do not match.
400InvalidBandwidthOut.LessThanZeroThe bandwidth must be larger than 0 when specifying isp.-
400HibernationConfigured.InstanceTypeNotSupportThe specified instance type is not support.-
400HibernationConfigured.ImageNotEncryptedThe hibernation configured instance only support encrypted image.-
400HibernationConfigured.MemorySizeTooBigThe hibernation configured instance memory size is too big.-
400InvalidSystemDiskSize.LessThanMemSizeThe specified parameter SystemDisk.Size is less than the memory size.-
400InvalidCloudBoxZone.OperationNotSupportedThe cloud box zone does not support creating prepaid or encrypted resources.-
400ProvisionedIopsForDiskCategoryUnsupportedThe specified disk category does not support provisioned iops.-
400InvalidProvisionedIops.LimitExceedThe provisioned iops exceeds the limit.-
400BurstingEnabledForDiskCategoryUnsupportedThe specified disk category does not support bursting enabled.-
400BurstingEnabledForMultiAttachDiskUnsupportedThe multi attach disk does not support bursting enabled.-
400ProvisionedIopsForDiskCategoryRequiredThe provisioned iops is required for this disk category.-
400NotSupportSnapshotEncrypted.InstanceTypeThe specified instance type does not support creating encrypted disks with native snapshot encrypt.-
400NotSupportSnapshotEncrypted.RegionIdThe specified region does not support creating encrypted disks with native snapshot encrypt.-
400NotSupportSnapshotEncrypted.ZoneIdThe specified zone does not support creating encrypted disks with native snapshot encrypt.-
400NotSupportSnapshotEncrypted.ShareImageShared snapshot creating encrypted disks with native snapshot encrypt is not supported.When you create encrypted disks based on a shared image, only the encryption key provided by the shared image can be used for these disks and you cannot specify encryption keys for the disks.
400NotSupportSnapshotEncrypted.ImageOwnerAliasThe specified image category does not support creating encrypted disks with native snapshot encrypt.-
400NotSupportSnapshotEncrypted.DiskCategoryThe specified disk category does not support creating encrypted disks with native snapshot encrypt.-
400NotSupport.SnapshotEncryptedAlgorithmConflictChanging encrypt algorithm with encrypted snapshot is not supported.-
400NoPermission.SystemTagThe operator is not permission for the system tag.You are not authorized to manage the system tag.
400NumberExceed.TagsThe Tags parameter's number is exceed , Valid : 20.-
400InvalidZoneId.NotSupportShareEncryptedImageCreating instances by shared encrypted images is not supported in this zone.-
400InvalidDiskCategory.NotSupportedThe specified disk category is not supported.The specified disk category does not support this operation.
400InvalidParameter.KMSKeyId.CMKUnauthorizedThis operation for kmsKeyId is forbidden by KMS. If you need further assistance, you can contact the KMS Technical Support.-
400InvalidParameter.CloudboxNotSupported%s-
400InvalidZoneId.NotSupportCreateWithShareEncryptedImageYou cannot use shared encrypted images to create instances in this zone.-
400InvalidParameter.NetworkCardIndexInvalidInvalid network card index, please check your instance type.-
400InvalidOperation.UserNotSupportNetworkCardUser not support network card.-
400InvalidInstanceType.NotSupportedThe specified instanceType does not support confidential computing mode: %s.-
400InvalidAccount.NotSupportSpotAccording to business rules, this account cannot purchase ECS Spot instances.-
400AccountForbidden.AssociatedWithResellerPartnerYour account is associated with your reseller partner. Your account or your reseller partner's account has been forbidden to create orders, please contact your reseller partner.-
400InvalidDestinationZone.DeploymentSetMismatchError happened, %s.-
400NoPermission.PriceThe operation requires price permission. Please either apply for permission from your main account, or set the parameter AutoPay as true.-
400InvalidAutoPay.PostPaidUnsupportedThe specified parameter AutoPay must be set as true for postpaid instance.-
400InvalidParam.EncryptedMismatchCreating encrypted disks with shared encrypted snapshots requires replacing encryption keys.-
400InvalidParameter.DedicatedRegionNotSupportedThe specified action is rejected because the specified ECS instance in the dedicated region does not support public IP.Parameter error codes not supported in the dedicated region
400InvalidParameter.CpuOptionsTopologyTypeThe specified parameter CpuOptions.TopologyType: %s is not valid.Illegal enumeration value for current CPU topology type
400InvalidInstanceType.NotSupportCpuOptionsTopologyTypeThe specified instance type does not support CpuOptions.TopologyType: %s.The current specification does not support the specified CPU topology type
400InvalidEniQueueSize.RegionOrUserNotSupportedThe specified parameter RxQueueSize or TxQueueSize is not supported in this region, or this account is not in the whitelist of using eni QueueSize.You are not authorized to specify the length of NIC queues or cannot specify the length of NIC queues in the current region.
400InvalidParameter.EniQueueSizeThe specified parameter TxQueueSize and RxQueueSize are not equal or exceed limit.The specified parameter TxQueueSize and RxQueueSize are not equal or exceed limit.
400InvalidParameter.KmsNotEnabledFailed to perform this operation because KMS is not activated.You need to activate KMS key management service.
400InvalidParameter.Encrypted.KmsNotEnableFailed to perform this operation because KMS is not activated.You need to activate KMS key escrow service.
400InvalidParam.EncryptedMismatchCreating encrypted disks with shared encrypted image requires replacing encryption keys.You must change the encryption key to create a cloud disk after sharing an encrypted image.
400InvalidPrivateIpAddress.DuplicatedThe specified private IP address is already in use.The specified IP address is already in use.
400InvalidAdditionalInfoPvdConfig.SizeExceededThe specified parameter AdditionalInfo.PvdConfig exceeds the size.-
400InvalidPrivateIpAddress.DuplicatedThe specified private IP address "%s" is duplicated.The specified IP address is already in use.
400InvalidParameter.EncryptedCreating non-encrypted disks with encrypted snapshots is not supported.Creating a non-encrypted disk with an encrypted snapshot is not supported.
400InvalidInstanceType.NotSupportHighDensityModeThe specified instance type does not support the use of the high density mode.The current instance type does not support the cloud disk high-density mode.
400QuotaExceeded.InternetBandwidth%s.Under your current account, the public network bandwidth of the Pay-As-You-Go ECS instance charged by fixed bandwidth exceeds the total bandwidth quota limit.
400InvalidParameter.CpuOptionsAcceleratorsThe specified parameter CpuOptionsAccelerators is not valid.The current accelerator type selection is illegal
400InvalidInstanceType.NotSupportCpuOptionsAcceleratorsThe specified instance type does not support attach accelerator.The current instance type does not support mounting accelerators.
401InvalidRamRole.NotEcsRoleThe specified ram role is not authorized for ecs, please check your role policy.The specified RAM role is not authorized to use ECS. Check your role policies.
403InvalidParameter.PrivateIpAddressRepeated%s-
403InvalidOperation.HighPerformanceEniPerInstanceLimitExceeded%s-
403InvalidParameter.EniNumExceededWithLaunchEcs%s-
403InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode%s-
403InvalidParameter.QueuePairNumberMustEmpty%s-
403InvalidParameter.EniTrafficMode%s-
403InvalidParameter.InvalidQueuePairNumberThe parameter of QueuePairNumber is invalid.-
403InvalidParam.IpCountThe parameter of ip count is invalid.-
403InvalidParameter.EniType%s-
403InvalidOperation.HighPerformanceTrafficModeIsNotAllowed%s-
403InvalidParameter.NetworkInterface%s-
403InvalidParameter.Combination%s-
403InvalidHostname.SingleAndMultiConflict%s-
403InvalidHostname.SizeInvalid%s-
403InvalidParams.InstanceNameExceedThe uniqueSuffix takes three naming places, please shorten your InstanceName.The instance name must be shortened to make space for the incremental suffix specified by UniqueSuffix. The incremental suffix is three characters in length.
403InvalidParams.HostnameExceedThe uniqueSuffix takes three naming places, please shorten your Hostname.The instance hostname must be shortened to make space for the incremental suffix specified by UniqueSuffix. The incremental suffix is three characters in length.
403ImageNotSubscribedThe specified image has not be subscribed.You have not subscribed to the specified image in Alibaba Cloud Marketplace.
403InvalidSystemDiskCategory.ValueUnauthorizedThe disk category is not authorized.You are not authorized to use the specified disk category.
403InvalidSnapshotId.NotReadyThe specified snapshot has not completed yet.The specified snapshot is being created.
403InstanceDiskCategoryLimitExceedThe total size of specified disk category in an instance exceeds.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 specified device has been occupied.
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 specified Alibaba Cloud Marketplace image is unavailable, or 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 specified disk category is unavailable in the specified zone.
403QuotaExceed.PortableCloudDiskThe quota of portable cloud disk exceeds.The maximum number of removable disks has been reached.
403SecurityGroupInstanceLimitExceedExceeding the allowed amount of instances of a security group.The maximum number of instances that can be added to the security group has been reached.
403NodeControllerUnavailableThe Node Controller is temporarily unavailable.The node controller is unavailable.
403RegionUnauthorizedThere is no authority to create instance in the specified region.You are not authorized to create instances in the specified region.
403CategoryNotSupportedThe specified Zone or cluster does not offer the specified disk category.The specified disk category is unavailable in the specified zone or cluster.
403InvalidSnapshotId.NotDataDiskSnapshotThe specified snapshot is system disk snapshot.The specified snapshot is a system disk snapshot.
403CategoryNotSupportedThe specified cluster does not offer the specified disk category.The specified disk category is unavailable in the specified cluster.
403ForbbidenUser not authorized to operate on the specified resource.You are not authorized to operate the specified resource.
403DeleteWithInstance.ConflictThe specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute.The specified disk is not removable and cannot be released along with the instance.
403InstanceDiskNumLimitExceedThe number of specified disk in an instance exceeds.The number of specified disks exceeds the upper limit for an instance.
403IoOptimized.NotSupportedThe specified image is not support IoOptimized Instance.The specified image does not support I/O optimized instances.
403InvalidDiskSize.TooSmallSpecified disk size is less than the size of snapshot.The specified disk size is smaller than the snapshot size.
403InvalidDiskCategory.MismatchThe specified disk categories combination is not supported.The combination of specified disk categories is not supported.
403IoOptimized.NotSupportedVpc is not support IoOptimized instance.The VPC does not support I/O optimized instances.
403InvalidDiskCategory.NotSupportedThe specified disk category is not support the specified instance type.The specified disk category does not support the instance type.
403QuotaExceed.BuyImageThe specified image is from the image market?You have not bought it or your quota has been exceeded.-
403InvalidResourceId.NotSupportedThe specified ResourceId does not support tagging.The specified resource does not support tagging.
403OperationDeniedThe specified RegionId does not support the creation of the network type ECS instance.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 specified image does not exist.
403OperationDenied.SnapshotNotValidThe specified snapshot is not allowed to create disk.The specified snapshot cannot be used to create disks.
403OperationDenied.SnapshotNotAllowedThe specified snapshot is not allowed to create disk.The specified snapshot cannot be used to create disks.
403OperationDenied.ZoneNotAllowedThe creation of Instance to the specified Zone is not allowed.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 specified disk category is unavailable in the specified zone or cluster, or the specified zone and cluster do not correspond to each other.
403OperationDenied.ResourceControlThe specified region is in resource control, please try later.The specified region is under resource control. Try again later.
403OperationDenied.NoStockThe resource is out of usage.The instance is not in the Running state. Start the instance or check whether the specified operation is valid.
403OperationDenied.SnapshotParamsNotValidThe capacity of snapshot exceeds the size limit of the specified disk category or the specified category is not authorizied.The maximum capacity of snapshots is exceeded or the user is not authorized to the specified category.
403OperationDenied.DiskTypeNotSupportThe type of the disk does not support the operation.-
403InvalidUserData.ForbiddenUser not authorized to input the parameter "UserData", please apply for permission "UserData".-
403Zone.NotOpenThe specified zone is not granted to you to buy resources yet.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.-
403InvalidClusterId.NotFoundThe specified clusterId does not exist.The specified ClusterId parameter does not exist.
403InvalidResourceType.NotSupported%s-
403OperationDenied.NoStockThe resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.The requested resources are unavailable in the specified zone. Try a different resource type or select a different region or zone.
403InvalidInstanceType.ZoneNotSupportedThe specified zone does not support this instancetype.The specified instance type is not supported in the specified zone.
403InstanceType.Offline%sThe 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 specified instance is a Windows instance and does not support logons using SSH key pairs.
403InvalidNetworkType.MismatchRamRoleA RAM role can?t be used for classic instance.-
403InvalidUser.PassRoleForbiddenThe RAM user does not have the privilege to pass a RAM role.The RAM user is not authorized to pass a RAM role.
403InvalidParam.TrustedSystemModeThe specified TrustedSystemMode is invalid.-
403InvalidParam.ConfidentialComputingModeThe specified ConfidentialComputingMode is invalid.-
403InvalidInstanceType.NotSupportedThe specified instance type does not support trusted system.-
403InvalidSecurityOptions.NotSupportedSecurityOptions for vTPM and Enclave can not both be set.-
403InvalidImage.NotSupportedThe specified vTPM instance need UEFI image.-
403InvalidInstanceType.NotSupportedThe specified instance type does not support Enclave.-
403InvalidImage.NotSupportedThe specified image does not support vSGX instance.-
403InvalidImage.NotSupportedThe specified image does not support Enclave instance.-
403Forbidden.RiskControlThis operation is forbidden by Aliyun RiskControl system.The operation is forbidden by the risk control system.
403InvalidInstance.UnPaidOrderThe specified Instance has unpaid order.The specified instance has a purchase order not paid for.
403RealNameAuthenticationErrorYour account has not passed the real-name authentication yet.You have not completed real-name verification. Complete real-name verification and try again.
403InvalidInstanceType.NotSupportedThe specified InstanceType is not Supported.The specified InstanceType parameter is invalid.
403InvalidPayMethodThe specified pay method is not valid.The specified payment method is invalid.
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403ImageNotSupportInstanceTypeThe specified image does not support the specified InstanceType.The specified image does not support the specified instance type.
403DryRun.InvalidAmount%s-
403OperationDenied.InvalidNetworkType%sThe network type does not support this operation.
403InvalidSpotInterruptionBehavior.ClassicNetworkNotSupportThe specified SpotInterruptionBehavior does not support Classic network Instance.-
403InvalidSpotInterruptionBehavior.LocalDiskNotSupportThe specified SpotInterruptionBehavior does not support local disk instance.-
403OperationDenied.ImageNotValid%sThe current image does not support this operation.
403QuotaExceed.PostPaidDiskLiving postPaid disks quota exceeded.-
403InvalidParameter.NotMatch%sA specified parameter is invalid. Check whether parameter conflicts exist.
403InvalidVSwitch.DefaultVSwitchNotSupportThe specified zone in vpc can't support create default vSwitch.-
403OperationDenied.ImageNotValidThe specified image is not published in the region.The image is unavailable in the current region.
403OperationDenied.ImageNotValidThe specified image is not authorized.You are not authorized to use this image.
403OperationDenied.ImageNotValidThe specified image is not found in marketplace.The specified image is not present in Alibaba Cloud Marketplace.
403OperationDenied.LocalDiskUnsupportedThe configuration change is not allowed when the specified instance has local disks mounted.Instance types cannot be changed for instances that have local disks attached.
403OperationDenied.InconsistentNetworkThe specified security group and vswitch are not in the same vpc.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 VPC and vSwitch have the same CIDR block and no additional vSwitches can be created in zones of the VPC.
403DefaultVswitch.ExistedThe default vswitch for VPC already exists.-
403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.The requested resources are insufficient.
403IncorrectInstanceStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
403CategoryViolationThe specified instance does not support this operation because of its disk category.The configurations of instances that have local disks attached cannot be upgraded or downgraded.
403ResourcesNotInSameZoneThe specified instance and dedicated host are not in the same zone.-
403InvalidDisk.SystemDiskSizeThe specified SystemDiskSize beyond the permitted range.The specified system disk size exceeds the maximum allowed value.
403InsufficientBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403InvalidOperation.NetworkInterface%s-
403MaxEniIpv6IpsCountExceeded%sThe maximum number of IPv6 addresses that can be assigned to the ENI has been reached.
403InvalidIp.IpRepeated%sThe specified IP address already exists.
403InvalidIp.IpAssigned%sThe specified IP address is already assigned.
403InvalidIp.Address%s-
403InvalidOperation.EniCountExceeded%s-
403InvalidOperation.Ipv4CountExceeded%sThe operation is valid because the maximum number of IPv4 addresses has been reached.
403InvalidOperation.Ipv6CountExceeded%sThe operation is valid because the maximum number of IPv6 addresses has been reached.
403InvalidOperation.Ipv6NotSupport%s-
403InvalidOperation.Ipv4NotSupport%s-
403InvalidParam.SecondaryIp%s-
403InvalidVSwitch.Ipv6NotTurnOn%sThe IPv6 feature is not enabled for your current vSwitch. Enable the feature and try again.
403InvalidParam.IpAssign%s-
403InvalidParam.Amount%sThe specified Amount parameter is invalid.
403InvalidParam.CpuOptionsCore%s-
403InvalidParam.CpuOptionsNuma%s-
403InvalidVSwitchId.IpInvalid%sThe specified private IP address is invalid.
403Forbidden.RegionId%sThe service is unavailable in the current region.
403QuotaExceed.DeploymentSetInstanceQuotaFullThe instance quota in one deployment set exceeded.-
403InvalidChargeType.ValueNotSupportedDeletion protection is only valid for postPaid instance, not for prePaid or spot instance.Release protection can be enabled only for pay-as-you-go instances.
403InvalidRegion.NotSupportThe specified region does not support byok.The bring your own key (BYOK) feature is not supported in the region.
403UserNotInTheWhiteListThe user is not in byok white list.You are not authorized to use the bring your own key (BYOK) feature. Try again when you are authorized.
403InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK.
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.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.-
403OperationDeniedThe user profile is not complete; try complete your basic info in account management page.-
403Mayi.InternalErrorThe request processing has failed due to some unknown error.-
403InvalidNetworkTypeThe network type is not support in this region.-
403InvalidAccountStatusYour account status is invalid, please contact customer service.-
403QuotaExceeded.PrivateIpAddress%s-
403OperationDenied.PerformanceLevelNotMatchThe specified DataDisk.n.PerformanceLevel and DataDisk.n.Size do not match.-
403InvalidStorageSetName.MalformedSpecified parameter StorageSetName is not valid.-
403InvalidDescription.MalformedSpecified parameter Description is not valid.-
403InvalidMaxPartitionNumber.MalformedSpecified parameter MaxPartitionNumber is not valid.-
403InvalidParameter.StorageSetPartitionNumberSpecified parameter StorageSetPartitionNumber is not valid.-
403InvalidParameter.StorageSetIdSpecified parameter StorageSetId is not valid.-
403InvalidParameter.StorageSetZoneIdSpecified parameter StorageSetZoneId is not valid.-
403EnterpriseGroupLimited.MutliGroupTypeThe specified instance can't join multi SecurityGroup types.-
403EnterpriseGroupLimited.InstanceTypeThe specified instance type doesn't support Enterprise SecurityGroup.-
403QuotaExceed.Tags%sThe number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
403OperationDenied.RegionIdNotSupportedThe specified region does not support spot duration instance.-
403OperationDenied.FlavorNotSupportedFlavor not support spot duration instance.-
403OperationDenied.TimestampNotSupportedTimestamp not support spot duration instance.-
403OperationDenied.PaygNotAvailablePay-as-you-go instance is not available now.-
403OperationDenied.PrepayNotAvailablePrepay instance is not available now.-
403OperationDenied.BidOwnResourceBid user can not own resource.-
403OperationDenied.CloudSSDNotSupportedThe specified available zone does not offer the cloud_ssd disk, use cloud_essd instead.-
403QuotaExceed.ElasticQuotaNo additional quota is available for the specified ECS instance type.The maximum number of instances of the specified instance type in the region has been reached. Reduce the quantity of instances that you want to purchase or try another region or instance type. Alternatively, you can go to the ECS console or 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 number of instances of the specified instance types exceeds the instance quota for the instance type. Log on to the Alibaba Cloud Management Console and submit a quota increase request.
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 number of vCPUs for the instance type exceeds the vCPUs quota. Log on to the Alibaba Cloud Management Console and submit a quota increase request.
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 number of instances of the specified instance type or the number of vCPUs exceeds the quota. Log on to the Alibaba Cloud Management Console and submit a quota increase request.
403QuotaExceeded.PostpaidDataDiskCapacityThe quota of postpaid data disk capacity exceeds.The used capacity of the pay-as-you-go disk reaches the quota limit.
403InvalidImageFamily.MissingAvailableImageThere is no available image related to the specified image family.-
403InvalidRegionId.NotSupportEncryptAlgorithmThe current region does not support creating encrypted disks with EncryptAlgorithm.-
403InvalidOperation.ResourceManagedByCloudProduct%sYou cannot modify security groups managed by cloud services.
403InvalidDiskSize.TooSmallSpecified disk size is too small when choosing PL0 of cloud_essd.-
403UserNotInTheWhiteListThe user is not in Arns white list.-
403InvalidManagedPrivateSpaceId.DedicatedHostIdConflictManagedPrivateSpaceId and DedicatedHostId cannot be specified at the same time.-
403InvalidManagedPrivateSpaceId.TenancyConflictManagedPrivateSpaceId and Tenancy cannot be specified at the same time.-
403InvalidParameter.InvalidEniQueueNumber%s-
403InvalidOperation.MaxEniQueueNumberExceeded%s-
403InvalidOperation.ExceedInstanceTypeQueueNumber%sThe maximum number of queues for all ENIs on an instance has been exceeded. For more information, see the return value of the %s placeholder in the error message.
403InvalidIspType.ValueNotSupported%s-
403UnsupportedIspChargeType%s-
403UnsupportedIspClassicNetwork%s-
403InvalidIspBandwidthOut%s-
403UnsupportedIspNetworkChargeType%s-
403InvalidIspUID%s-
403UnsupportedIspRegion%s-
403DeleteWithInstance.ConflictThe specified image is from the image market, you cannot set DeleteWithInstance attribute to false.-
403Forbidden.OnlySupportEnterpriseGroup%s-
403HibernationConfigured.InstanceOperationForbiddenThe operation is not permitted due to limit of the hibernation configured instance.The operation cannot be performed due to the limitations of instances for which the instance hibernation feature is enabled.
403InstanceDiskLimitExceededThe amount of the disk on instance reach its limits.-
403InvalidInstanceType.NotSupportDiskCategoryThe instanceType of the specified instance does not support this disk category.The instance type does not support the current disk category. Try another instance type. For information about the disk categories supported by instance types, see the instance family documentation.
403InvalidOperation.ConfidentialComputingModeInInviteOnlyTestingThe specified confidential computing mode is in invite only testing: %s.-
403InvalidOperation.InvalidNetworkInterfaceId%s-
403InvalidOperation.RegionNotSupportNetworkInterfaceIdThe specific region does not support network interface id.-
403InvalidEniId.NotFound%sThe specified ENI ID does not exist.
403NotSupportSnapshotEncrypted.DiskCategoryThe specified disk category does not support creating encrypted system disks or creating encrypted data disks from snapshots. Check the DiskCategory or Encrypted parameter, or check your account for default encryption settings.This disk type does not support creating encrypted system disks or creating encrypted data disks in snapshot mode. Please check the disk type and encryption parameters you entered, or check whether you have configured the default encryption configuration for account cloud disks.
403InvalidEncrypted.DefaultEncryptionUnsupportedThe specified parameter Encrypted must be true when default encryption is enabled.After the cloud disk is encrypted by default, the newly purchased cloud disk must be an encrypted cloud disk.
403InvalidOperation.PublicIpAddressNoStockThe public IP address for the specified Region or ChargeType of the instance is out of stock. Please try another Region or ChargeType.Under the conditions of the specified region or payment type, the public IP address inventory of the instance is insufficient. Please try another region or payment type.
403QuotaExceed.ElasticQuotaThe request failed due to elastic quota check, details as follows: %s.If your ECS usage exceeds the quota limit, go to the Alibaba Cloud console to apply for a quota increase.
403AclLimitExceed%sThe number of ACL rules for an ENI or instance exceeds the upper limit.
403OperationDenied.ImageNotValidThe specified image is not available, please check the status of the image.The specified image is not available, please check the status of the image.
404InvalidStorageClusterId.NotExistThe specified StorageClusterId does not exist in current region.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404InvalidZoneId.NotFoundThe ZoneId provided does not exist in our records.The specified zone ID does not exist.
404InvalidSecurityGroupIdThe specified SecurityGroupId is invalid or does not exist.The specified security group ID is invalid or does not exist.
404InvalidDataDiskSnapshotId.NotFoundThe specified parameter "DataDisk.n.SnapshotId" is not valid.-
404InvalidClusterId.NotFoundThe ClusterId provided does not exist in our records.The specified ClusterId parameter does not exist.
404InvalidVSwitchId.NotFoundSpecified virtual switch does not exist.The specified vSwitch ID does not exist.
404InvalidVSwitchId.NotFound%sThe specified vSwitch does not exist.
404InvalidImageId.NotFoundThe specified ImageId does not exist.The specified image does not exist in this account. Check whether the image ID is correct.
404IoOptimized.NotSupportedThe specified instancetype is not support IoOptimized instance.-
404InvalidInstanceChargeType.NotFoundThe InstanceChargeType does not exist in our records.The specified instance billing method does not exist.
404DependencyViolation.IoOptimizedThe specified instancetype must be IoOptimized instance.The specified instance type must be I/O optimized. Check your instance type and try again.
404PaymentMethodNotFoundNo payment method has been registered on the account.You have not configured a payment method for your account.
404HOSTNAME_ILLEGALThe specified parameter HostName is not valid.-
404InvalidSystemDiskSize.LessThanImageSizeThe specified parameter SystemDisk.Size is less than the image size.The specified system disk size is smaller than the image size.
404InvalidSystemDiskSize.LessThanMinSizeThe specified parameter SystemDisk.Size is less than the min size.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 specified SystemDisk.Size value is greater than the upper limit.
404OperationDenied.CreatingConflictAnother Instance has been creating.-
404InvalidZoneId.NotFoundThe specified zoneId does not exist.The specified zone ID does not exist.
404InvalidKeyPairName.NotFoundThe specified parameter KeyPairName does not exist in our records.The specified key pair does not exist.
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The specified resource group does not exist.
404InvalidRamRole.NotFoundThe specified parameter "RAMRoleName" does not exist.-
404InvalidLaunchTemplate.NotFound%sThe specified launch template does not exist. Check whether the parameter value is correct.
404InvalidLaunchTemplateVersion.NotFound%sThe specified version of the launch template does not exist. Check whether the parameter values are correct.
404InvalidVSwitchId.NotExist%sThe specified vSwitch does not exist.
404InvalidMarketImage.NotFoundThe specified marketplace image does not exist, please change the imageId and try again.The specified Alibaba Cloud Marketplace image does not exist. Modify the ImageId parameter and try again.
404DeploymentSet.NotFoundThe specified deployment set does not exist.The specified deployment set does not exist.
404InvalidParameter.DeploymentSetGroupNoParameter DeploymentSetGroupNo is invalid.-
404InvalidParameter.KMSKeyId.NotFoundThe specified KMSKeyId does not exist.The specified KMSKeyId parameter does not exist.
404InvalidSecurityGroupId.NotFound%sThe specified security group ID does not exist.
404InvalidDiskIds.NotPortableThe specified DiskId is not portable.The specified disk is not removable.
404InvalidAutoSnapshotPolicyId.NotFoundSpecified parameter AutoSnapshotPolicyId not found.-
429Throttling.ResourceThe request throttle by resource operation.-
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.
500InvalidParameter.DataEncryptedKeyCreateFailedCreate kms data encrypted key fail. If you need further assistance, you can contact the KMS Technical Support.-
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-11-05The Error code has changedView Change Details
2024-10-14The Error code has changedView Change Details
2024-09-27The Error code has changedView Change Details
2024-08-29The Error code has changedView Change Details
2024-08-21The Error code has changedView Change Details
2024-08-08The Error code has changed. The request parameters of the API has changedView Change Details
2024-07-03The Error code has changedView Change Details
2024-06-27The Error code has changedView Change Details
2024-05-11The Error code has changedView Change Details
2024-03-22The Error code has changedView Change Details
2024-03-21The Error code has changedView Change Details
2024-02-28The Error code has changedView Change Details
2024-01-30The Error code has changedView Change Details
2024-01-24The Error code has changedView Change Details
2024-01-15The Error code has changedView Change Details
2023-12-14The Error code has changed. The request parameters of the API has changedView Change Details
2023-10-10The Error code has changedView Change Details
2023-10-09The Error code has changedView Change Details
2023-09-04The Error code has changedView Change Details
2023-08-29The Error code has changedView Change Details