All Products
Search
Document Center

Elastic Compute Service:RunInstances

Last Updated:Sep 14, 2026

Creates multiple ECS instances in a batch, with support for automatic startup, public IP address assignment, and automatic release time configuration.

Operation description

Before using this operation, make sure you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl) of ECS.

This operation is asynchronous. After a successful request, the instance IDs are returned. The instances are not created and started immediately. You can call DescribeInstanceStatus to query the instance status. When the status returned is Running, the instances are created and started successfully.

Before you begin

  • If resources are insufficient to complete the instance creation, Alibaba Cloud immediately sends an instance creation failure event (SystemFailure.Delete). You can call DescribeInstanceHistoryEvents to check for instance creation failure events. For more information, see Instance creation failure events.

  • Make sure the total number of instances you create or the total number of vCPUs across all instance types does not exceed your quota. For more information, see Quota Center.

  • Before creating a VPC-type ECS instance, create a VPC in the corresponding Alibaba Cloud region.

Precautions

  • If the billing method is subscription (PrePaid), active coupon are applied by default at the time of payment.

  • A single request can create up to 100 instances. If you need to create more than 100 instances, send multiple requests in batches or concurrently.

  • If the value of the InternetMaxBandwidthOut parameter is greater than 0, a public IP address is automatically allocated to the instance.

Note

The total peak public bandwidth for pay-by-bandwidth instances under a single Alibaba Cloud account in a single region is subject to limits. For more information, see Public bandwidth limits.

Usage recommendations

  • Testing: Send a dry run request by setting DryRun=true.

  • Releasing instances: Set the automatic release time using the AutoReleaseTime parameter, or invoke DeleteInstances to perform manual release.

  • Management and retrieve: Assign tags (Tag.N.Key and Tag.N.Value) to each batch of instances, and add sequential suffixes (UniqueSuffix) to hostnames (HostName) and instance names (InstanceName). For more information, see Set sequential instance names or hostnames in batch.

  • Launch templates: Use a launch template to avoid specifying a large number of configuration parameters each time you create an instance. Invoke CreateLaunchTemplate to create a launch template, then specify LaunchTemplateId and LaunchTemplateVersion in the RunInstances request to use the template.

  • Disabling hyper-threading: In memory-intensive workloads, set CpuOptions.ThreadsPerCore=1 to disable hyper-threading and improve the memory-to-CPU ratio.

  • Enabling jumbo frames: Set NetworkOptions.EnableJumboFrame=true to enable the Jumbo frame attribute at instance creation. For more information, see ECS instance MTU.

Request examples

Suppose you want to create ECS instances in the China (Hangzhou) region using a specific image, instance type, security group, and vSwitch, with a configured system disk and data disk, a public IP address, and a specified instance name and password. The relevant request parameters are as follows:

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

Based on the above configuration, create different types of instances:

Example: Create 5 subscription instances with auto-renewal

Amount:5, // number of instances: 5
InstanceChargeType:"PrePaid", // billing method: subscription
PeriodUnit:"Month", // billing cycle unit: month
Period:1, // billing cycle: 1 month
AutoRenew:true, // enable auto-renewal
AutoRenewPeriod:1 // renewal period: 1 month

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

Amount:10, // number of instances: 10
InstanceChargeType:"PostPaid", // billing method: pay-as-you-go
SpotStrategy:"NoSpot" // default value, Normal pay-as-you-go

Example: Create 20 spot instances with a bidding policy and retention period

Amount:20, // number of instances: 20
InstanceChargeType:"PostPaid",
SpotStrategy:"SpotAsPriceGo", // bidding policy: automatically bid at the current marketplace price
SpotDuration:1 // spot instance retention period: 1 hour

Suppose you have already created a launch template using CreateLaunchTemplate and want to use it to create ECS instances in the China (Hangzhou) region. The example is as follows:

Example: Create 10 ECS instances from a launch template

RegionId:"cn-hangzhou", // China (Hangzhou) region
Amount:10, // number of instances: 10
LaunchTemplateId:"lt-bp14xczpoxvb6rre****" // launch template ID
Important If both instance parameters and template parameters are specified, the instance parameters take precedence. For example, if the template uses subscription as the billing method but InstanceChargeType is set to PostPaid, the created instances use pay-as-you-go billing.

Example: Create 1 instance using a full image (an ECS instance backup that includes both the system disk and data disks)

RegionId:"cn-hangzhou", // China (Hangzhou) region
ImageId = m-bp13ohd32cvzpq9e****, // custom image ID
InstanceType = ecs.u1-c1m1.large, // instance type
SecurityGroupId = sg-bp10jztp6b0sdsyl****, // security group ID
VSwitchId = vsw-bp19wo63nleroq22g****, // vSwitch ID
SystemDisk.Size = 50, // system disk size included in the full image
SystemDisk.Category = cloud_auto, // disk type of the system disk included in the full image
DataDisk.1.Device = /dev/xvdb, // attach point of the data disk included in the full image
DataDisk.1.Size = 50, // size of the data disk included in the full image
DataDisk.1.Category = cloud_essd, // disk type of the data disk included in the full image
DataDisk.2.Device = /dev/xvdc, // attach point of the additional data disk. To replace the data disk included in the full image with the additional data disk, set DataDisk.1.Device = /dev/xvdb (the default attach point of the data disk in the full image).
DataDisk.2.Size = 70, // size of the additional data disk
DataDisk.2.Category = cloud_auto, // disk type of the additional data disk

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:RunInstances

create

*All Resource

*

  • vpc:IsDefaultVSwitch
  • vpc:IsDefaultVpc
  • vpc:VPC
  • ecs:IsDiskEncrypted
  • ecs:InstanceTypeFamily
  • ecs:InstanceType
  • ecs:ImageOwnerId
  • ecs:ImageSource
  • ecs:NotSpecifySecurityGroupId
  • ecs:LoginAsNonRoot
  • ecs:IsSystemDiskByokEncrypted
  • ecs:IsDiskByokEncrypted
  • ecs:PasswordInherit
  • ecs:PasswordCustomized
  • ecs:IsSystemDiskEncrypted
  • ecs:ImagePlatform
  • ecs:IsDiskEncrypted
  • ecs:SecurityHardeningMode
  • ecs:AssociatePublicIpAddress
  • vpc:CreateDefaultVpc
  • ecs:SecurityEnhancementStrategy
  • ecs:InstanceChargeType
None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

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

cn-hangzhou

ImageId

string

No

The ID of the image used to create the instance. You can call DescribeImages to query available images. If you do not specify LaunchTemplateId or LaunchTemplateName to identify a launch template, and do not use ImageFamily to select the latest available image from an image family, ImageId is required.

aliyun_2_1903_x64_20G_alibase_20200324.vhd

ImageFamily

string

No

The name of the image family. Set this parameter to use the latest available image from the specified image family to create the instance.

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

Note the following:

  • If ImageId is specified, do not set this parameter.

  • If ImageId is not specified but the launch template identified by LaunchTemplateId or LaunchTemplateName has ImageId configured, do not set this parameter.

  • If ImageId is not specified and the launch template identified by LaunchTemplateId or LaunchTemplateName does not have ImageId configured, you can set this parameter.

  • If ImageId is not specified and neither LaunchTemplateId nor LaunchTemplateName is specified, you can set this parameter.

Note

For the image family information associated with Alibaba Cloud official images, see Overview of public images.

hangzhou-daily-update

InstanceType

string

No

The instance type. If you do not specify LaunchTemplateId or LaunchTemplateName to identify a launch template, InstanceType is a required parameter.

ecs.g6.large

SecurityGroupId

string

No

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

Note

The network type of the instance is determined by SecurityGroupId. For example, if the security group uses a VPC network, the instance is also VPC-type, and you must also specify VSwitchId.

If you do not specify LaunchTemplateId or LaunchTemplateName to identify a launch template, SecurityGroupId is required. Note the following:

  • You can specify a single security group using SecurityGroupId, or specify one or more security groups using SecurityGroupIds.N. You cannot set both SecurityGroupId and SecurityGroupIds.N at the same time.

  • If NetworkInterface.N.InstanceType is set to Primary, do not set SecurityGroupId or SecurityGroupIds.N. Use NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N instead.

sg-bp15ed6xe1yxeycg7****

VSwitchId

string

No

The ID of the vSwitch. If you are creating a VPC-type ECS instance, you must specify a vSwitch ID. The security group and vSwitch must belong to the same VPC. You can call DescribeVSwitches to query existing vSwitches.

Note the following:

  • If you specify VSwitchId, the ZoneId you specify must match the zone where the vSwitch resides. You can also omit ZoneId, and the system automatically selects the zone where the specified vSwitch resides.

  • If NetworkInterface.N.InstanceType is set to Primary, do not set VSwitchId. Use NetworkInterface.N.VSwitchId instead.

vsw-bp1s5fnvk4gn2tws0****

InstanceName

string

No

The instance name. The name must be 2 to 128 characters in length and can contain Unicode letters (including English and Chinese characters) and digits. It can also contain colons (:), underscores (_), periods (.), and hyphens (-). The default value is the InstanceId of the instance.

When creating multiple ECS instances, you can set sequential instance names in batch. The name can contain brackets ([]) and commas (,). For more information, see Set sequential instance names or hostnames in batch.

k8s-node-[1,4]-alibabacloud

Description

string

No

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

Instance_Description

InternetMaxBandwidthIn

integer

No

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

  • If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s: 1 to 10. Default value: 10.

  • If the purchased outbound public bandwidth is greater than 10 Mbit/s: 1 to the value of InternetMaxBandwidthOut. Default value: the value of InternetMaxBandwidthOut.

10

InternetMaxBandwidthOut

integer

No

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

Default value: 0.

10

HostName

string

No

The hostname of the instance. The following limits apply:

  • Periods (.) and hyphens (-) cannot be used as the first or last character, or used consecutively.

  • Windows instances: The hostname must be 2 to 15 characters in length. Periods (.) are not supported. The hostname cannot consist of digits only. It can contain uppercase and lowercase letters, digits, and hyphens (-).

  • Other instance types (such as Linux):
    • The hostname must be 2 to 64 characters in length. Multiple periods (.) are supported. Each segment between periods can contain uppercase and lowercase letters, digits, and hyphens (-).

    • You can use the placeholder ${instance_id} to include the instance ID in the hostname. For example, if HostName=k8s-${instance_id} and the instance ID is i-123abc****, the hostname is k8s-i-123abc****.

When creating multiple ECS instances, you can:

  • Set sequential hostnames in batch. For more information, see Set sequential instance names or hostnames in batch.

  • Use the HostNames.N parameter to set a different hostname for each instance. Note that HostName and HostNames.N cannot be specified at the same time.

k8s-node-[1,4]-ecshost

UniqueSuffix

boolean

No

Specifies whether to automatically append a sequential suffix to HostName and InstanceName when creating multiple instances. The sequential suffix starts from 001 and cannot exceed 999. Valid values:

  • true: appends the suffix.

  • false: does not append the suffix.

Default value: false.

If HostName or InstanceName is set in a specified sort format without a name suffix (name_suffix), that is, the format is name_prefix[begin_number,bits], UniqueSuffix does not take effect and names are sorted only in the specified order.

For more information, see Set sequential instance names or hostnames in batch.

true

Password

string

No

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

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

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

Note

If you specify Password, send the request over HTTPS to prevent password leakage.

EcsV587!

PasswordInherit

boolean

No

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

When this parameter is used, the Password parameter must be empty, and the image you use must have a password configured.

false

ZoneId

string

No

The ID of the zone where the instance resides. You can call DescribeZones to query the list of zones.

Note

If you specify VSwitchId, the ZoneId you specify must match the zone where the vSwitch resides. You can also omit ZoneId, and the system automatically selects the zone where the specified vSwitch resides.

Default value: automatically selected by the system.

cn-hangzhou-g

InternetChargeType

string

No

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth.

  • PayByTraffic: pay-by-traffic.

Default value: PayByTraffic.

Note

In pay-by-traffic mode, the peak inbound and outbound bandwidth values are upper limits and are not guaranteed. When resource contention occurs, the peak bandwidth may be limited. If your workloads require guaranteed bandwidth, use pay-by-bandwidth mode.

PayByTraffic

SystemDisk.Size

string

No

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

  • Basic disk: 20 to 500.

  • Enterprise SSD:
    • PL0: 1 to 2048.

    • PL1: 20 to 2048.

    • PL2: 461 to 2048.

    • PL3: 1261 to 2048.

  • ESSD AutoPL disk: 1 to 2048.

  • Other disk types: 20 to 2048.

The value of this parameter must be greater than or equal to max{1, ImageSize}.

Default value: max{40, the size of the image specified by the ImageId parameter}.

40

SystemDisk.Category

string

No

The disk type of the system disk. Valid values:

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: enterprise SSD.

  • cloud: basic disk.

  • cloud_auto: ESSD AutoPL disk.

  • cloud_essd_entry: ESSD Entry disk.

Default value description:

  • If the instance type is a retired non-I/O optimized instance type, the default value is cloud.

  • In all other cases, the default value is cloud_efficiency.

Note

cloud_essd_entry is supported only when InstanceType is set to u1, universal instance family (ecs.u1) or e, economy instance family (ecs.e).

cloud_ssd

SystemDisk.DiskName

string

No

The name of the system disk. The name must be 2 to 128 characters in length and can contain Unicode letters (including English, Chinese, and digits). It can also contain colons (:), underscores (_), periods (.), and hyphens (-).

cloud_ssdSystem

SystemDisk.Description

string

No

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

SystemDisk_Description

SystemDisk.PerformanceLevel

string

No

The performance level of the enterprise SSD used as the system disk. Valid values:

  • PL0: maximum random read/write IOPS of 10,000 per disk.

  • PL1 (default): maximum random read/write IOPS of 50,000 per disk.

  • PL2: maximum random read/write IOPS of 100,000 per disk.

  • PL3: maximum random read/write IOPS of 1,000,000 per disk.

For information about how to choose an ESSD performance level, see Enterprise SSDs.

PL0

SystemDisk.AutoSnapshotPolicyId

string

No

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

sp-bp67acfmxazb4p****

IoOptimized

string

No

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

  • none: non-I/O optimization.

  • optimized: I/O optimized instance.

optimized

UserData

string

No

The custom data of the instance. The data must be Base64-encoded, and the size of the data before Base64 encoding cannot exceed 32 KB.

For information about the limits, formats, and execution frequency of instance custom data, see Instance user data.

Note

To protect the security of UserData during transmission, avoid passing sensitive data such as passwords and private keys in plaintext. If you need to pass such information, encrypt it first and then Base64-encode it. Decrypt the data inside the instance to ensure security.

ZWNobyBoZWxsbyBlY3Mh

KeyPairName

string

No

The name of the SSH key pair.

Note

This parameter is ignored for Windows instances and is empty by default. Even if this parameter is specified, only the Password content is used.

KeyPair_Name

RamRoleName

string

No

The name of the instance RAM role. You can call the RAM API ListRoles to query the instance RAM roles you have created.

RAM_Name

Amount

integer

No

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

The number of instances successfully created depends on the values of Amount and MinAmount:

  • If MinAmount is not specified: the system creates the number of instances specified by Amount. If inventory is insufficient, the API returns a creation failure and no instances are created.

  • If MinAmount is specified:

    • If available inventory < MinAmount: no instances are created and the API returns a creation failure.

    • If MinAmount ≤ available inventory < Amount: instances are created based on available inventory and the API returns a success.

    • If available inventory ≥ Amount: instances are created based on the specified Amount and the API returns a success.

Default value: 1.

3

MinAmount

integer

No

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

The number of instances successfully created depends on the values of Amount and MinAmount:

  • If MinAmount is not specified: the system creates the number of instances specified by Amount. If inventory is insufficient, the API returns a creation failed response and no instances are created.

  • If MinAmount is specified:

    • If available inventory < MinAmount: no instances are created and the API returns a creation failed response.

    • If MinAmount ≤ available inventory < Amount: instances are created based on available inventory and the API returns a success.

    • If available inventory ≥ Amount: instances are created based on the specified Amount and the API returns a success.

2

AutoReleaseTime

string

No

The automatic release time for pay-as-you-go instances. Specify the time in ISO 8601 format in UTC+0. The format is yyyy-MM-ddTHH:mm:ssZ.

  • If the seconds (ss) value is not 00, it is automatically set to the start of the current minute (mm).

  • The earliest release time is 30 minutes from the current time.

  • The latest release time cannot be more than three years from the current time.

2018-01-01T12:05:00Z

SpotStrategy

string

No

The bidding strategy for pay-as-you-go instances. This parameter takes effect when InstanceChargeType is set to PostPaid. Valid values:

  • NoSpot: standard pay-as-you-go instance.

  • SpotWithPriceLimit: spot instance with a maximum price.

  • SpotAsPriceGo: spot instance where the system automatically bids at the current market price.

Default value: NoSpot.

NoSpot

SpotDuration

integer

No

The retention period of the spot instance. Unit: hours. Valid values:

  • 1: Alibaba Cloud guarantees that the instance runs for 1 hour after creation without automatic release. After 1 hour, the system compares the bid price against the marketplace price and checks resource inventory in real-time to determine whether to retain or revoke the instance.

  • 0: Alibaba Cloud does not guarantee the runtime of the instance. The system compares the bid price against the marketplace price and checks resource inventory in real-time to determine whether to retain or revoke the instance.

Default value: 1.

Note
  • Currently, this parameter only supports values of 0 or 1.

  • Spot instances are billed by the second. Choose a retention period based on the expected execution duration of your task.

  • Alibaba Cloud sends a notification through an ECS system event 5 minutes before the instance is revoked.

1

SpotPriceLimit

number

No

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

0.97

SpotInterruptionBehavior

string

No

The interruption mode for spot instances. Valid values:

Default value: Terminate.

Terminate

SecurityEnhancementStrategy

string

No

Specifies whether to enable security hardening. Valid values:

  • Active: enables security hardening. This value applies only to public images.

  • Deactive: disables security hardening. This value applies to all image types.

Active

ClientToken

string

No

The client token used to ensure the idempotency of the request. Generate a unique value for this parameter from your client to ensure that different requests use different values. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotency.

123e4567-e89b-12d3-a456-426655440000

HpcClusterId

string

No

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

This parameter is required when creating an SCC instance. You can create an HPC cluster by calling CreateHpcCluster.

hpc-bp67acfmxazb4p****

DryRun

boolean

No

Specifies whether to perform only a dry run for this request. Valid values:

  • true: sends a check request without creating the instance. The check includes whether required parameters are specified, the request format, business limits, and ECS inventory. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.

  • false (default): sends a normal request. If the check passes, the instance is created immediately.

false

DedicatedHostId

string

No

The ID of the dedicated host.

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

Important Dedicated hosts do not support spot instances. If DedicatedHostId is specified, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored.

dh-bp67acfmxazb4p****

LaunchTemplateId

string

No

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

When creating an instance from a launch template, you must specify either LaunchTemplateId or LaunchTemplateName to identify the template.

lt-bp1apo0bbbkuy0rj****

LaunchTemplateName

string

No

The name of the launch template.

When creating an instance from a launch template, you must specify either LaunchTemplateId or LaunchTemplateName to identify the template.

LaunchTemplate_Name

LaunchTemplateVersion

integer

No

The version of the launch template. If you specify LaunchTemplateId or LaunchTemplateName without specifying a version number, the default version is used.

3

ResourceGroupId

string

No

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

rg-bp67acfmxazb4p****

Period

integer

No

The subscription period of the resource. The unit is specified by PeriodUnit. This parameter is required and takes effect only when InstanceChargeType is set to PrePaid. If DedicatedHostId is specified, the value cannot exceed the subscription period of the dedicated host. Valid values:

If PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60.

1

PeriodUnit

string

No

The unit of the subscription period. Valid values:

Month (default).

Month

AutoRenew

boolean

No

Specifies whether to enable auto-renewal. This parameter takes effect only when InstanceChargeType is set to PrePaid. Valid values:

  • true: enables auto-renewal.

  • false: disables auto-renewal.

Default value: false.

true

AutoRenewPeriod

integer

No

The auto-renewal period for a single renewal. Valid values:

If PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, 60.

Default value: 1.

1

InstanceChargeType

string

No

The billing method of the instance. Valid values:

  • PrePaid: subscription.

  • PostPaid: pay-as-you-go.

Default value: PostPaid.

If you select subscription, make sure your account supports credit payment. Otherwise, the error InvalidPayMethod is returned.

PrePaid

DeploymentSetId

string

No

The ID of the deployment set.

ds-bp1brhwhoqinyjd6****

DeploymentSetGroupNo

integer

No

The group number of the instance within the deployment set. This parameter takes effect when the deployment set uses the high availability group policy (AvailabilityGroup). Valid values: 1 to 7.

1

PrivateIpAddress

string

No

The private IP address of the instance. When setting a private IP address for a VPC-type ECS instance, you must select an available IP address from the CIDR block of the vSwitch (VSwitchId).

Note the following:

  • After you set PrivateIpAddress:

    • If Amount is set to 1, a private IP address is assigned to the created ECS instance.

    • If Amount is set to a value greater than 1, the specified private IP address is used as the starting address, and consecutive private IP addresses are assigned to multiple ECS instances in sequence. In this case, secondary ENIs cannot be attached to the instances (that is, NetworkInterface.N.* parameters are not supported).

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set PrivateIpAddress. Set NetworkInterface.N.PrimaryIpAddress instead.

Note

The first IP address and the last three IP addresses of each vSwitch are reserved by the system and cannot be specified. For example, if the CIDR block of a vSwitch is 192.168.1.0/24, the addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved.

10.1.**.**

CreditSpecification

string

No

Sets the running mode of a burstable instance. Valid values:

  • Standard: standard mode. For more information about the performance of instances in standard mode, see the performance constraint mode section in What are burstable instances.

  • Unlimited: unlimited mode. For more information about the performance of instances in unlimited mode, see the unlimited mode section in What are burstable instances.

Standard

Ipv6AddressCount

integer

No

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

Note the following:

  • You cannot specify both Ipv6Address.N and Ipv6AddressCount.

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set Ipv6Address.N or Ipv6AddressCount. Use NetworkInterface.N.Ipv6Address.N or NetworkInterface.N.Ipv6AddressCount instead.

1

NetworkInterfaceQueueNumber

integer

No

The number of queues supported by the primary ENI. Note the following:

  • The value cannot exceed the maximum number of queues per ENI allowed by the instance type.

  • The total number of queues across all ENIs on the instance cannot exceed the total queue quota for the instance type. To query the maximum number of queues per ENI and the total queue quota for an instance type, call DescribeInstanceTypes and check the MaximumQueueNumberPerEni and TotalEniQueueQuantity fields.

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set NetworkInterfaceQueueNumber. Use NetworkInterface.N.QueueNumber instead.

8

DeletionProtection

boolean

No

Specifies whether to enable release protection for the instance. This parameter controls whether the instance can be released through the console or by calling DeleteInstance. Valid values:

  • true: enables release protection.

  • false: disables release protection.

Default value: false.

Note

This parameter applies only to pay-as-you-go instances. It prevents manual release operations only and does not apply to system-initiated release operations.

false

HibernationOptions.Configured

boolean

No

Note

This parameter is currently in invitational preview and is not available for use.

false

Affinity

string

No

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

  • default: The instance is not associated with a dedicated host. If the instance is in economical mode and is stopped and then restarted, the instance is placed on another dedicated host in the automatic deployment resource pool if the original dedicated host has insufficient resources.

  • host: The instance is associated with a dedicated host. If the instance is in economical mode and is stopped and then restarted, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the instance fails to restart.

Default value: default.

default

Tenancy

string

No

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

  • default: creates a non-dedicated host instance.

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

Default value: default.

default

StorageSetId

string

No

The ID of the storage set.

ss-bp67acfmxazb4p****

StorageSetPartitionNumber

integer

No

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

2

CpuOptions.Core

integer

No

The number of CPU cores.

2

CpuOptions.ThreadsPerCore

integer

No

The number of threads per CPU core. The number of vCPUs for an ECS instance equals CpuOptions.Core × CpuOptions.ThreadsPerCore.

  • Setting CpuOptions.ThreadsPerCore=1 disables hyper-threading.

  • Only some instance types support custom CPU thread counts.

2

CpuOptions.Numa

string

No

This parameter is deprecated.

1

CpuOptions.TopologyType

string

No

The CPU topology type of the instance. Valid values:

  • ContinuousCoreToHTMapping: When ContinuousCoreToHTMapping is selected, the hyper-threads (HTs) of the same core in the CPU topology structure are contiguous.

  • DiscreteCoreToHTMapping: When DiscreteCoreToHTMapping is selected, the HTs of the same core are discrete.

Default value: none.

Note

Only some instance families support this parameter. For the supported instance families, see View and modify the CPU topology structure.

DiscreteCoreToHTMapping

SecurityOptions.TrustedSystemMode

string

No

The trusted system mode. Set the value to vTPM.

The trusted system mode currently supports the following instance families:

  • g7, c7, r7.

  • Enhanced instance families (g7t, c7t, r7t).

When you create an ECS instance of the above instance families, configure this parameter as follows:

  • To use the Alibaba Cloud Trusted System, set this parameter to vTPM. The trusted system then performs a trusted verification when the instance starts.

  • If you do not use the Alibaba Cloud Trusted System, you can leave this parameter unset. However, if the ECS instance uses Enclave confidential computing mode (SecurityOptions.ConfidentialComputingMode=Enclave), the trusted system is also enabled for the instance.

  • To create a trusted instance by calling an API operation, invoke RunInstances. CreateInstance does not support the SecurityOptions.TrustedSystemMode parameter.

Note

If you specify an instance as a trusted instance at creation time, you can only use images that support the trusted system when you replace the system disk.

For more information about the trusted system, see Overview of the trusted feature for security-enhanced instances.

vTPM

SecurityOptions.ConfidentialComputingMode

string

No

The confidential computing mode. Set the value to Enclave.

When this parameter is set to Enclave, the ECS instance uses Enclave to build a confidential computing environment. Currently, only instance types in instance families c7, g7, and r7 support setting this parameter when invoking RunInstances. Note the following:

  • The confidential computing feature is in invitational preview.

  • To create an ECS instance with Enclave confidential computing by calling an API operation, invoke RunInstances. CreateInstance does not support the SecurityOptions.ConfidentialComputingMode parameter.

  • Enclave confidential computing relies on the trusted system (vTPM). When you configure an ECS instance to use Enclave for confidential computing, the trusted system is also enabled for the instance. If you set SecurityOptions.ConfidentialComputingMode=Enclave when calling this operation, the created ECS instance enables both Enclave confidential computing pattern and the trusted system, regardless of whether you set SecurityOptions.TrustedSystemMode=vTPM.

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

Enclave

HttpEndpoint

string

No

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

  • enabled: enables the access channel.

  • disabled: disables the access channel.

Default value: enabled.

Note

For more information about instance metadata, see Overview of instance metadata.

enabled

HttpTokens

string

No

Specifies whether to enforce the use of hardened mode (IMDSv2) when accessing instance metadata. Valid values:

  • optional: does not enforce hardened mode.

  • required: enforces hardened mode. After you set this value, the instance metadata cannot be accessed in normal mode.

Default value: optional.

Note

For more information about instance metadata access modes, see Instance metadata access modes.

optional

HttpPutResponseHopLimit

integer

No

Note

This parameter is not available for use.

0

PrivatePoolOptions.MatchCriteria

string

No

The private pool capacity option for starting the instance. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for starting instances. Valid values:

  • Open: open mode. The system automatically matches an open private pool. If no matching open private pool is available, the instance is started from the public pool. In this mode, you do not need to set PrivatePoolOptions.Id.

  • Target: targeted mode. The instance is started from the specified private pool. If the specified private pool is unavailable, the instance fails to start. In this mode, you must specify a private pool ID by setting PrivatePoolOptions.Id.

  • None: no private pool mode. The instance is started without using a private pool.

Default value: None.

In the following scenarios, the private pool capacity option can only be set to None or left unset:

  • Creating a spot instance.

  • Creating an ECS instance on a dedicated host (DDH).

Open

PrivatePoolOptions.Id

string

No

The ID of the private pool, which is the ID of the elasticity assurance or capacity reservation.

eap-bp67acfmxazb4****

Isp

string

No

Note

This parameter is currently in invitational preview and is not available for use.

null

SchedulerOptions.DedicatedHostClusterId

string

No

The ID of the dedicated host cluster to which the ECS instance belongs. The system automatically selects a dedicated host from the specified cluster to deploy the ECS instance.

Note

This parameter takes effect only when Tenancy is set to host.

If you specify both a dedicated host (DedicatedHostId) and a dedicated host cluster (SchedulerOptions.DedicatedHostClusterId):

  • If the dedicated host belongs to the dedicated host cluster, the ECS instance is preferentially deployed on the specified dedicated host.

  • If the dedicated host does not belong to the dedicated host cluster, the ECS instance fails to be created.

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

dc-bp12wlf6am0vz9v2****

SecurityGroupIds

array

No

Adds the instance to multiple security groups at the same time. The valid values of N depend on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.

Note:

  • You cannot specify both SecurityGroupId and SecurityGroupIds.N at the same time.

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set SecurityGroupId or SecurityGroupIds.N. Set NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N instead.

sg-bp15ed6xe1yxeycg7****

string

No

Adds the instance to multiple security groups at the same time. The valid values of N depend on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.

Note:

  • You cannot specify both SecurityGroupId and SecurityGroupIds.N at the same time.

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set SecurityGroupId or SecurityGroupIds.N. Set NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N instead.

sg-bp15ed6xe1yxeycg7****

HostNames

array

No

The hostnames of instances when you create multiple instances at a time. Each instance is assigned a unique hostname.

ecs-host-01

string

No

The hostname of each instance when you create multiple instances at a time. The following limits apply:

  • The number of values for N must match the value of Amount. For example, if Amount=2, specify the hostnames in the following format: HostNames.1=test1 and HostNames.2=test2.

  • You cannot specify both HostName and HostNames.N at the same time.

  • A period (.) or hyphen (-) cannot be the first or last character of a hostname, and consecutive periods (.) or hyphens (-) are not allowed.

  • Windows instances: The hostname must be 2 to 15 characters in length. It cannot contain periods (.) or consist entirely of digits. It can contain uppercase and lowercase letters, digits, and hyphens (-).

  • Other instance types (such as Linux): The hostname must be 2 to 64 characters in length. Multiple periods (.) are supported. Each segment between periods can contain uppercase and lowercase letters, digits, and hyphens (-).

ecs-host-01

DataDisk

array<object>

No

The list of data disk information collections.

object

No

The data disk information collection.

AutoSnapshotPolicyId

string

No

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

sp-bp67acfmxazb4p****

BurstingEnabled

boolean

No

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

  • true: yes.

  • false: no.

Note

This parameter is valid only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disk.

false

Category

string

No

The category of data disk N. Valid values:

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: enterprise SSD (ESSD).

  • cloud: basic disk.

  • cloud_auto: ESSD AutoPL disk.

  • cloud_regional_disk_auto: regional ESSD.

  • cloud_essd_entry: ESSD Entry disk.
    Note

    This value is supported only when InstanceType is set to an instance type in the ecs.u1 or ecs.e instance family.

  • elastic_ephemeral_disk_standard: elastic ephemeral disk - standard edition.

  • elastic_ephemeral_disk_premium: elastic ephemeral disk - premium edition.

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

  • If InstanceType is a retired non-I/O optimization instance type, the default value is cloud.

  • In all other cases, the default value is cloud_efficiency.

cloud_ssd

DeleteWithInstance

boolean

No

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

  • true: The data disk is released when the instance is released.

  • false: The data disk is not released when the instance is released.

Default value: true.

true

Description

string

No

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

DataDisk_Description

Device

string

No

The mount point of the data disk. The naming convention for mount points varies based on the number of data disks attached:

  • 1 to 25 data disks: /dev/xvd[b-z]

  • More than 25 data disks: /dev/xvd[aa-zz]. For example, the 26th data disk is named /dev/xvdaa, the 27th is /dev/xvdab, and so on.

Note
  • This parameter is used only in full image (system image) scenarios. You can set this parameter to the mount point of a data disk in the full image, and modify the corresponding DataDisk.N.Size and DataDisk.N.Category parameters to change the category and size of that data disk.

  • When you use a full image to create an instance, the data disks in the full image are created as the first 1 to n data disks of the ECS instance.

/dev/xvdb

DiskName

string

No

The name of the data disk. The name must be 2 to 128 characters in length and can contain Unicode characters in the letter category, including letters in English, Chinese, and digits. It can also contain colons (:), underscores (_), periods (.), and hyphens (-).

cloud_ssdData

EncryptAlgorithm

string

No

Note

This parameter is not available for use.

null

Encrypted

string

No

Specifies whether to encrypt data disk N. Valid values:

  • true: encrypts the data disk.

  • false: does not encrypt the data disk.

Default value: false.

Important When you use a shared encrypted image to create a disk based on an encrypted snapshot, you must set the request parameter Encrypted=true for the disk to ensure that the disk uses the key of the account with which the image is shared.

false

KMSKeyId

string

No

The ID of the KMS key used for the data disk.

Note

If Encrypted is set to true and KMSKeyId is not specified, the default key is used for encryption. The KMSKeyId value is returned after the instance is created.

    • Disk created from a non-shared encrypted snapshot: The encryption key used by the snapshot is used by default.

    • Disk created from a shared encrypted snapshot: The service key is used by default.

    • Disk created in a region where account-level default encryption for block storage is enabled: The specified account-level key is used by default.

    • All other cases: The service key is used by default.

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

PerformanceLevel

string

No

The performance level of the ESSD used as the data disk. Settings for the performance level (PL) of the disk. The value of N must match the N in DataDisk.N.Category=cloud_essd. Valid values:

  • PL0: maximum random read/write IOPS of 10,000 per disk.

  • PL1 (default): maximum random read/write IOPS of 50,000 per disk.

  • PL2: maximum random read/write IOPS of 100,000 per disk.

  • PL3: maximum random read/write IOPS of 1,000,000 per disk.

For information about how to choose an ESSD performance level, see Enterprise SSD.

PL1

ProvisionedIops

integer

No

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × capacity − baseline performance}.

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

Note

This parameter is valid only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disk.

40000

Size

integer

No

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

  • cloud_efficiency: 20 to 32768.

  • cloud_ssd: 20 to 32768.

  • cloud_essd: The valid values depend on the value of DataDisk.N.PerformanceLevel.
    • PL0: 1 to 65,536.

    • PL1: 20 to 65,536.

    • PL2: 461 to 65,536.

    • PL3: 1,261 to 65,536.

  • cloud: 5 to 2,000.

  • cloud_auto: 1 to 65,536.

  • cloud_essd_entry: 10 to 32,768.

Note

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

2000

SnapshotId

string

No

The snapshot used to create data disk N. N ranges from 1 to 16.

If DataDisk.N.SnapshotId is specified, DataDisk.N.Size is ignored. The size of the created disk equals the size of the specified snapshot. Snapshots created on or before July 15, 2013 are not supported. Requests that use such snapshots are rejected.

s-bp17441ohwka0yuh****

StorageClusterId

string

No

The ID of the dedicated block storage cluster. If you want to use a disk from a dedicated block storage cluster as the data disk when creating an ECS instance, set this parameter.

dbsc-j5e1sf2vaf5he8m2****

Arn

array<object>

No

Note

This parameter is not available for use.

object

No

Note

This parameter is not available for use.

AssumeRoleFor

integer

No

Note

This parameter is not available for use.

null

RoleType

string

No

Note

This parameter is not available for use.

null

Rolearn

string

No

Note

This parameter is not available for use.

null

NetworkInterface

array<object>

No

The network interface controller (NIC) information.

object

No

The network interface controller (NIC) information.

DeleteOnRelease

boolean

No

Specifies whether to retain the ENI when the instance is released. Valid values:

  • true: The ENI is not retained.

  • false: The ENI is retained.

Default value: true.

Note

This parameter takes effect only for secondary ENIs.

true

Description

string

No

The description of the network interface controller (NIC).

Note:

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

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

  • If NetworkInterface.N.InstanceType is set to Primary, you do not need to set this parameter.

Network_Description

InstanceType

string

No

The type of the network interface controller (NIC). The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

Valid values:

  • Primary: primary ENI.

  • Secondary: secondary ENI.

Default value: Secondary.

Secondary

Ipv6Address

array

No

One or more IPv6 addresses assigned to the primary ENI. You can specify up to 10 IPv6 addresses. The valid values of the second N range from 1 to 10.

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

Note:

  • This parameter takes effect only when NetworkInterface.N.InstanceType is set to Primary. If NetworkInterface.N.InstanceType is set to Secondary or left empty, you cannot set this parameter.

  • If this parameter is set, Amount can only be set to 1, and you cannot set Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6AddressCount.

string

No

The IPv6 address.

2001:db8:1234:1a00::***

Ipv6AddressCount

integer

No

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

Note:

  • This parameter takes effect only when NetworkInterface.N.InstanceType is set to Primary. If NetworkInterface.N.InstanceType is set to Secondary or left empty, you cannot set this parameter.

  • If this parameter is set, you cannot set Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6Address.N.

1

NetworkCardIndex

integer

No

The index of the physical network card assigned to the ENI.

Note:

  • Only specific instance types support specifying a physical network card index.

  • If NetworkInterface.N.InstanceType is set to Primary, and the instance type supports physical network cards, you can only set this parameter to 0.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, and the instance type supports physical network cards, you can set this parameter based on the instance type. For more information, see Instance families.

0

NetworkInterfaceId

string

No

The ID of the network interface controller (NIC) to attach to the instance.

If this parameter is set, Amount can only be set to 1.

Note

This parameter takes effect only for secondary ENIs. After you specify an existing secondary ENI, you cannot configure other NIC creation parameters.

eni-bp1gn106np8jhxhj****

NetworkInterfaceName

string

No

The name of the network interface controller (NIC). The name must be 2 to 128 characters in length and can contain Unicode characters in the letter category, including letters in English, Chinese, and digits. It can also contain colons (:), underscores (_), periods (.), and hyphens (-).

Note:

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

  • If NetworkInterface.N.InstanceType is set to Primary, you do not need to set this parameter.

Network_Name

NetworkInterfaceTrafficMode

string

No

The communication pattern of the network interface controller (NIC). Valid values:

  • Standard: uses the TCP communication mode.

  • HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the RDMA communication mode.

Default value: Standard.

Note

The number of NICs in RDMA mode cannot exceed the limit for the instance type. For more information, see Instance families.

Standard

PrimaryIpAddress

string

No

The primary IP address of the network interface controller (NIC) to add.

Note:

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

    • If you add one NIC, you can add one primary ENI or one secondary ENI. If Amount is greater than 1 and you configure a primary ENI with this parameter, consecutive primary IP addresses starting from the specified IP address are batch-allocated to multiple ECS instances in sequence. In this case, you cannot attach a secondary ENI to the instances.

    • If Amount is greater than 1 and this parameter is set for the primary ENI, you cannot configure a secondary ENI (that is, you cannot set NetworkInterface.2.InstanceType=Secondary).

  • If NetworkInterface.N.InstanceType is set to Primary, this parameter has the same effect as PrivateIpAddress. However, you cannot set both this parameter and PrivateIpAddress at the same time.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter specifies the primary IP address of the secondary ENI. By default, a random IP address is selected from the CIDR block of the vSwitch to which the ENI belongs.

Note

The first and last three IP addresses of each vSwitch CIDR block are system reserved IP addresses and cannot be specified. For example, if the vSwitch CIDR block is 192.168.1.0/24, the addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved.

172.16.**.**

QueueNumber

integer

No

The number of queues for the network interface controller (NIC).

Note:

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

  • The value cannot exceed the maximum number of queues per NIC allowed by the instance type.

  • The total number of queues across all NICs on the instance cannot exceed the total queue quota for the instance type. You can call DescribeInstanceTypes to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity fields for the instance type.

  • If NetworkInterface.N.InstanceType is set to Primary and this parameter is set, you cannot set NetworkInterfaceQueueNumber.

8

QueuePairNumber

integer

No

The number of queue pairs for the RDMA ENI.

If you want to attach multiple RDMA ENIs to the instance, set QueuePairNumber for each ENI based on the maximum QueuePairNumber supported by the instance type and the number of ENIs you plan to use. Make sure the total QueuePairNumber across all ENIs does not exceed the maximum allowed for the instance type. Call DescribeInstanceTypes to query the limit for the instance type.

Important If QueuePairNumber is not specified for an RDMA ENI, the maximum QueuePairNumber supported by the instance type is used by default. Therefore, once you attach an RDMA ENI without specifying QueuePairNumber, you cannot attach additional RDMA ENIs (this restriction does not apply to standard ENIs).

0

RxQueueSize

integer

No

The inbound queue depth of the network interface controller (NIC).

Note

This parameter is in invitational preview and is not available for general use. To use this parameter, submit a ticket.

Note:

  • This parameter applies only to seventh-generation and later ECS instance types.

  • This parameter currently applies only to Linux images.

  • A larger inbound queue depth improves inbound throughput and reduces packet loss, but consumes more memory.

8192

SecondaryPrivateIpAddressCount

integer

No

The number of secondary private IPv4 addresses to allocate to the NIC. Valid values: 1 to 49.

  • The value cannot exceed the IP address limit for the instance type. For more information, see Instance families.

  • NetworkInterface.N.SecondaryPrivateIpAddressCount specifies the number of secondary private IPv4 addresses to allocate to the NIC (excluding the primary private IP address of the NIC). The system randomly allocates the addresses from the available CIDR block of the vSwitch (NetworkInterface.N.VSwitchId) to which the NIC belongs.

10

SecurityGroupId

string

No

The ID of the security group to which the network interface controller (NIC) belongs.

Note:

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

  • If NetworkInterface.N.InstanceType is set to Primary, this parameter is required. It has the same effect as SecurityGroupId. However, you cannot set SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N at the same time.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the security group of the ECS instance.

sg-bp67acfmxazb4p****

SecurityGroupIds

array

No

The IDs of one or more security groups to which the network interface controller (NIC) belongs.

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

  • The second N indicates that you can specify one or more security group IDs. The valid values of the second N depend on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.

Note:

  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter or NetworkInterface.N.SecurityGroupId. This parameter has the same effect as SecurityGroupIds.N. However, you cannot set SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId at the same time.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the security group of the ECS instance.

sg-bp15ed6xe1yxeycg7****

string

No

The IDs of one or more security groups to which the network interface controller (NIC) belongs.

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

  • The second N indicates that you can specify one or more security group IDs. The valid values of the second N depend on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.

Note:

  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter or NetworkInterface.N.SecurityGroupId. This parameter has the same effect as SecurityGroupIds.N. However, you cannot set SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId at the same time.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the security group of the ECS instance.

sg-bp15ed6xe1yxeycg7****

SourceDestCheck

boolean

No

Specifies whether to enable source/destination checking. We recommend that you enable this feature to improve network security. Valid values:

  • true: yes.

  • false: no.

Default value: false.

Note

This feature is supported only in certain regions. Before using it, read Source/destination checking carefully.

false

TxQueueSize

integer

No

The outbound queue depth of the network interface controller (NIC).

Note

This parameter is in invitational preview and is not available for general use. To use this parameter, submit a ticket.

Note:

  • This parameter applies only to seventh-generation and later ECS instance types.

  • This parameter currently applies only to Linux images.

  • A larger outbound queue depth improves outbound throughput and reduces packet loss, but consumes more memory.

8192

VSwitchId

string

No

The ID of the vSwitch to which the network interface controller (NIC) belongs.

Note:

  • The value of N cannot exceed the maximum number of NICs supported by the instance type. See Instance families or invoke DescribeInstanceTypes to query the maximum number of NICs supported by the target instance type.

  • If NetworkInterface.N.InstanceType is set to Primary, this parameter is required. It has the same effect as VSwitchId. However, you cannot set VSwitchId at the same time.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the vSwitch of the ECS instance.

vsw-bp67acfmxazb4p****

Tag

array<object>

No

The tags of the instance, disk, and primary ENI.

object

No

The tags of the instance, disk, and primary ENI.

Key

string

No

The tag key of the instance, disk, and primary ENI. N ranges from 1 to 20. If this parameter is specified, it cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:, and cannot contain http:// or https://.

TestKey

Value

string

No

The tag value of the instance, disk, and primary ENI. N ranges from 1 to 20. If this parameter is specified, it can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://.

TestValue

Ipv6Address

array

No

One or more IPv6 addresses assigned to the primary ENI. You can specify up to 10 IPv6 addresses. N ranges from 1 to 10.

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

Note:

  • If Ipv6Address.N is set, Amount can only be set to 1, and you cannot set Ipv6AddressCount at the same time.

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set Ipv6Addresses.N or Ipv6AddressCount. Set NetworkInterface.N.Ipv6Addresses.N or NetworkInterface.N.Ipv6AddressCount instead.

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

string

No

One or more IPv6 addresses assigned to the primary ENI. You can specify up to 10 IPv6 addresses. N ranges from 1 to 10.

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

Note:

  • If Ipv6Address.N is set, Amount can only be set to 1, and you cannot set Ipv6AddressCount at the same time.

  • If NetworkInterface.N.InstanceType is set to Primary, you cannot set Ipv6Addresses.N or Ipv6AddressCount. Set NetworkInterface.N.Ipv6Addresses.N or NetworkInterface.N.Ipv6AddressCount instead.

2001:db8:1234:1a00::***

SystemDisk

object

No

The system disk parameters. Currently, the dedicated block storage cluster ID (StorageClusterId) must be set through this parameter.

BurstingEnabled

boolean

No

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

  • true: yes.

  • false: no.

Note

This parameter is valid only when SystemDisk.Category is set to cloud_auto. For more information, see ESSD AutoPL disk.

false

EncryptAlgorithm

string

No

Note

This parameter is not available for use.

null

Encrypted

string

No

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

Encrypting the system disk during instance creation is not supported in China (Hong Kong) Zone D or Singapore Zone A.

Important When you use a shared encrypted image to create a disk based on an encrypted snapshot, you must set the request parameter Encrypted=true for the disk to ensure that the disk uses the key of the account with which the image is shared.

false

KMSKeyId

string

No

The ID of the KMS key used for the system disk.

Note

If Encrypted is set to true and KMSKeyId is not specified, the default key is used for encryption. The KMSKeyId value is returned after the instance is created.

    • Disk created from a non-shared encrypted snapshot: The encryption key used by the snapshot is used by default.

    • Disk created from a shared encrypted snapshot: The service key is used by default.

    • Disk created in a region where account-level default encryption for block storage is enabled: The specified account-level key is used by default.

    • All other cases: The service key is used by default.

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

ProvisionedIops

integer

No

The provisioned read/write IOPS of the ESSD AutoPL system disk. Valid values: 0 to min{50,000, 1,000 × capacity − baseline performance}.

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

Note

This parameter is valid only when SystemDisk.Category is set to cloud_auto. For more information, see ESSD AutoPL disk.

40000

StorageClusterId

string

No

The ID of the dedicated block storage cluster. If you want to use a disk from a dedicated block storage cluster as the system disk when creating an ECS instance, set this parameter.

dbsc-j5e1sf2vaf5he8m2****

ImageOptions

object

No

The image-related attributes.

LoginAsNonRoot

boolean

No

Specifies whether the instance that uses this image supports logon as the ecs-user user. Valid values:

  • true: yes.

  • false: no.

false

NetworkOptions

object

No

The network-related parameters.

BandwidthWeighting

string

No

The bandwidth weight of the instance. The valid values vary by instance type. To query the bandwidth weight tiers supported by a specific instance type, call DescribeInstanceTypes and check the BandwidthWeighting field in the response. You can use the name field values from the response, such as Vpc-L1 and Ebs-L1.

Default

EnableJumboFrame

boolean

No

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

  • false: disables Jumbo Frame. The MTU value for all ENIs on the instance (including the primary ENI and secondary ENIs) is set to 1500.

  • true: enables Jumbo Frame. The MTU value for all ENIs on the instance (including the primary ENI and secondary ENIs) is set to 8500.

Default value: true.

Note

Only some eighth-generation and later instance types support the Jumbo Frame feature. For more information, see ECS instance MTU.

false

EnableNetworkEncryption

boolean

No

Note

This parameter is in invitational preview and is not available for general use.

AutoPay

boolean

No

Specifies whether to automatically complete the payment when creating an instance. Valid values:

  • true: automatically completes the payment.

    Note

    If automatic payment is enabled, make sure that your payment method has sufficient balance. Otherwise, an abnormal order is generated and can only be voided. If your payment method has insufficient balance, set AutoPay to false. An unpaid order is then generated, which you can pay for in the ECS console.

  • false: generates an order without charging.

    Note

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

Default value: true.

true

PrivateDnsNameOptions

object

No

The private DNS name configuration for the instance.

For information about private Private domain resolution, see ECS private Private domain resolution.

EnableInstanceIdDnsAAAARecord

boolean

No

Specifies whether to enable DNS resolution from the instance ID-based domain name to an IPv6 address. Valid values:

  • true: enabled.

  • false: disabled.

Default value: false.

true

EnableInstanceIdDnsARecord

boolean

No

Specifies whether to enable DNS resolution from the instance ID-based domain name to an IPv4 address. Valid values:

  • true: enabled.

  • false: disabled.

Default value: false.

false

EnableIpDnsARecord

boolean

No

Specifies whether to enable DNS resolution from the IP-based domain name to an IPv4 address. Valid values:

  • true: enabled.

  • false: disabled.

Default value: false.

true

EnableIpDnsPtrRecord

boolean

No

Specifies whether to enable reverse DNS resolution from an IPv4 address to the IP-based domain name. Valid values:

  • true: enabled.

  • false: disabled.

Default value: false.

false

HostnameType

string

No

The hostname type. Valid values:

  • Custom: custom hostname.

  • IpBased: IP address-based hostname.

  • InstanceIdBased: instance ID-based hostname.

Default value: Custom.

Custom

ClockOptions

object

No

The instance clock parameters.

PtpStatus

string

No

The PTP status. Valid values:

  • enabled: enables PTP.

  • disabled: disables PTP.

Default value: disabled.

Valid values:

  • disabled :

    Disables PTP.

  • enabled :

    Enables PTP.

enabled

CpuOptions

object

No

NestedVirtualization

string

No

Note

This parameter is in invitational preview and is not available for general use.

enabled

SecurityOptions

object

No

EnableSecureBoot

boolean

No

Specifies whether to enable UEFI Secure Boot.

ManagedHostId

string

No

The unique identifier of the platform-managed host, such as mh-f2d3647ca21****.

mh-f2d3647ca21****

Response elements

Element

Type

Description

Example

object

The collection of information returned when an instance is created.

InstanceIdSets

object

InstanceIdSet

array

The list of instance IDs.

string

The instance ID.

i-bp67acfmxazb4ph****

OrderId

string

The order ID. This parameter is returned only when a subscription ECS instance is created (the request parameter InstanceChargeType=PrePaid).

123456****

RequestId

string

The request ID.

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

TradePrice

number

The transaction price of the order.

0.165

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 LoginAsNonRoot.ImageNotSupport The specified image does not support login as non-root. The image does not support the logons of non-root users.
400 InvalidVSwitch.Ipv4NotEnabled The specify VSwitch of ECS does not support IPv4.
400 InvalidParam.NotSupportJumboFrame Not support jumbo frame.
400 InsufficientBalance.AgentCredit Insufficient agent credit. Please contact your agent. Your credit balance is insufficient. Contact your agent for an adjustment.
400 QuotaExceed.DiskCapacity The 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.
400 InvalidPeriod.ExceededDedicatedHost Instance expired date can not exceed dedicated host expired date. The expiration date of the instance is later than that of the dedicated host.
400 InvalidParam.SecondaryNetworkInterface When min amount greater than 1 and the PrivateIpAddress or Primary NetworkInterface is specified,the Secondary NetworkInterface IP parameter cannot be specified.
400 InvalidPrimaryIpAddress.SizeInvalid The NetworkInterface PrimaryIpAddress is used to create only one instance.
400 InvalidStorageClusterId.CapacityNotEnough The 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.
400 InvalidStorageClusterId.StatusNotSupport The current status of the dedicated storage cluster cannot create a cloud disk yet.
400 InvalidStorageClusterId.ZoneIdEmpty The specified param ZoneId cannot be empty when StorageClusterId given.
400 InvalidStorageClusterId.PerformanceLevelNotMatch The current dedicated storage cluster cannot create this performance level of disk.
400 InvalidStorageClusterId.CategoryNotMatch The current dedicated storage cluster cannot create this category of disk.
400 InvalidStorageClusterId.DiskSizeEmpty The specified param DiskSize cannot be empty when StorageClusterId given.
400 InvalidInstanceType.ValueUnauthorized The specified InstanceType is not authorized.
400 InvalidInstanceType.ValueNotSupported The specified InstanceType beyond the permitted range. The specified instance type is invalid because it is out of the available range.
400 InvalidDescription.Malformed The specified parameter "Description" is not valid. The source description can be 2 to 256 characters in length. It cannot start with http:// and https://.
400 InvalidInternetChargeType.ValueNotSupported The specified InternetChargeType is not valid. The specified InternetChargeType parameter is invalid.
400 InvalidParameter The specified parameter "InternetMaxBandwidthOut" is not valid.
400 InvalidHostName.Malformed The specified parameter "HostName" is not valid. The specified HostName parameter is invalid.
400 InvalidPassword.Malformed The specified parameter "Password" is not valid. The specified Password parameter is invalid.
400 InvalidPasswordParam.Mismatch The input password should be null when passwdInherit is true. The Password parameter must be left empty when the PasswdInherit parameter is used.
400 InvalidSystemDiskCategory.ValueNotSupported The specified parameter "SystemDisk.Category" is not valid. The specified parameter system disk specification is invalid.
400 InvalidDiskName.Malformed The specified parameter "SyatemDisk.DiskName or DataDisk.n.DiskName" is not valid. The disk name specified in the parameter DiskName invalid.
400 InvalidDiskDescription.Malformed The specified parameter "SyatemDisk.DiskDescription" or "DataDisk.n.Description" is not valid.
400 InvalidDataDiskSize.ValueNotSupported The 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.
400 InvalidDataDiskCategory.ValueNotSupported The specified parameter "DataDisk.n.Category" is not valid.
400 InvalidDataDevice.Malformed The specified parameter "DataDisk.n.Device" is not valid.
400 InvalidNodeControllerId.Malformed The specified parameter "NodeControllerId" is not valid.
400 InvalidInnerIpAddress.Malformed The specified parameter "InnerIpAddress" is not valid.
400 InvalidInnerIpAddress.Unusable The specified InnerIpAddress is already used or not found in usable ip range. The specified internal IP address is unavailable.
400 InvalidParameter.Conflict The specified image does not support the specified instance type. The specified image cannot be used for instances of the specified instance type.
400 ImageNotSupportCloudInit The specified image does not support cloud-init. The specified image does not support CloudInit.
400 InvalidSnapshotId.BasedSnapshotTooOld The specified snapshot is created before 2013-07-15. The specified snapshot was created before July 15, 2013.
400 QuotaExceed.AfterpayInstance Living afterpay instances quota exceeded. The maximum number of pay-as-you-go instances has been reached.
400 InvalidInstanceName.Malformed The specified parameter "InstanceName" is not valid. The specified InstanceName parameter is invalid.
400 InvalidInstanceName.CustomMalformed Customized section of instance or host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].
400 InvalidParameter.Mismatch Specified security group and virtual switch are not in the same VPC. The specified security group and vSwitch do not belong to the same VPC.
400 InvalidNetworkType.Mismatch Specified parameter "InternetMaxBandwidthIn" or "InternetMaxBandwidthOut" conflict with instance network type.
400 InvalidPrivateIpAddress Specified 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.
400 InvalidPrivateIpAddress.Malformed Specified private IP address is malformed. The specified private IP address is invalid.
400 QuotaExceeded.PrivateIpAddress Don't have enough private IPs in this switch.
400 QuotaExceeded Living instances quota exceeded in this VPC.
400 IncorrectVSwitchStatus The current status of virtual switch does not support this operation. The specified vSwitch is in the Pending state and cannot be deleted.
400 ResourceNotAvailable Resource you requested is not available in this region or zone.
400 MissingParameter The input parameter "VSwitchId" that is mandatory for processing this request is not supplied.
400 InvalidDiskCategory.Mismatch The specified disk categories' combination is not supported.
400 MissingParamter The specified parameter "Period" is not null. The Period parameter cannot be empty.
400 InvalidPeriod The specified period is not valid. The specified period is invalid.
400 InstanceDiskCategoryLimitExceed The 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.
400 InvalidClientToken.ValueNotSupported The ClientToken provided is invalid. The specified ClientToken parameter is invalid.
400 InvalidIoOptimize.ValueNotSupported The specified IoOptimize is not valid. The specified IoOptimized parameter is invalid.
400 InvalidSecurityGroupId.NotFound The SecurityGroupId provided does not exist in our records.
400 InvalidInternetMaxBandwidthOut.Malformed The specified parameter internetMaxBandwidthOut is not valid. The specified InternetMaxBandwidthOut parameter is invalid.
400 InvalidInternetMaxBandwidthIn.Malformed The specified parameter internetMaxBandwidthIn is not valid. The specified InternetMaxBandwidthIn parameter is invalid.
400 InvalidSnapshotId.NotFound The specified parameter SnapshotId is not exist. The specified snapshot does not exist. Check whether the snapshot ID is valid.
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. The specified Tag.N.Key parameter is invalid.
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. The specified tag value is invalid.
400 InvalidTag.Mismatch The 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.
400 InvalidTagCount The specified tags are beyond the permitted range. The number of specified tags exceeds the upper limit.
400 InvalidMinAmount.Malformed The specified parameter MinAmount is not valid. The specified MinAmount parameter is invalid.
400 InvalidMaxAmount.Malformed The specified parameter MaxAmount is not valid. The specified MaxAmount parameter is invalid.
400 InvalidAutoReleaseTime.Malformed The specified parameter AutoReleaseTime is not valid. The specified automatic release time AutoReleaseTime is invalid.
400 OperationDenied.NoVlan The specified parameter "VlanId" is not valid or vlan has not enough IP address.
400 OperationDenied.QuotaExceed The quota of tags on resource is beyond permitted range.
400 Account.Arrearage Your account has been in arrears. Your account does not have enough balance. Please add funds to your account.
400 InvalidUserData.SizeExceeded The specified parameter "UserData" exceeds the size.
400 InvalidUserData.NotSupported TThe specified parameter "UserData" only support the vpc and IoOptimized Instance.
400 InvalidUserData.Base64FormatInvalid The specified UserData is not valid. The specified user data is invalid.
400 InstanceDiskNumber.LimitExceed The total number of specified disk in an instance exceeds. The number of disks on an instance exceeds the upper limit.
400 InvalidDiskCategory.ValueNotSupported The specified parameter "DiskCategory" is not valid. The specified cloud disk type DiskCategory is invalid.
400 InvalidSpotStrategy The specified SpotStrategy is not valid. The specified SpotStrategy parameter is invalid.
400 InvalidSpotParam.EmptyZoneID The specified zoneid is empty when SpotStrategy is set.
400 InvalidSpotPriceLimit The specified SpotPriceLimitis not valid. The specified SpotPriceLimit parameter is invalid.
400 InvalidSpotDuration The specified SpotDuration is not valid. The specified SpotDuration parameter is invalid.
400 InvalidSpotAuthorized The specified Spot param is unauthorized. You are not authorized to set the SpotDuration parameter.
400 InvalidSpotPrepaid The specified Spot type is not support PrePay Instance. Spot instances do not support the subscription billing method.
400 InvalidSpotAliUid The specified UID is not authorized to use SPOT instance. You are not authorized to create spot instances.
400 InvalidParameter.Bandwidth %s The specified bandwidth value is invalid.
400 RegionUnauthorized %s The user is not authorized to create instances in the specified region.
400 Zone.NotOnSale %s The requested resources are unavailable in the specified zone. %s is a variable. An error message is dynamically returned based on call conditions.
400 InvalidSystemDiskSize.ValueNotSupported %s The specified system disk size is invalid.
400 InvalidInstanceType.ElasticNetworkInterfaceNotSupported The 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.
400 InvalidParameter.EncryptedIllegal %s The 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.
400 InvalidParameter.EncryptedNotSupported %s The 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.
400 InvalidSpotPriceLimit.LowerThanPublicPrice The specified parameter "spotPriceLimit" can't be lower than current public price. The specified SpotPriceLimit parameter cannot be lower than the current public price.
400 InvalidRelationResource.NotFound The relation resource has been deleted. The associated resource has been deleted.
400 IncorrectRecycleBinStatus The operation is not permitted due to resource status. The resource is in a state that does not support the current operation.
400 InvalidHpcClusterId.Unnecessary The specified HpcClusterId is unnecessary. The HpcClusterId parameter is specified.
400 InvalidVSwitchId.Necessary The VSwitchId is necessary. The VSwitchId parameter is required.
400 InvalidHpcClusterId.Necessary The HpcClusterId is necessary. The HpcClusterId parameter is required.
400 InvalidHpcClusterId.NotFound The specified HpcClusterId is not found. The specified HpcClusterId parameter does not exist.
400 InvalidHpcClusterId.Creating The specified HpcClusterId is creating. The specified HPC cluster is being created.
400 InvalidParameter.VSwitchId %s
400 InvalidSecurityGroup.NotInDefaultVpc %s The security group is not in the default VPC. Check whether the specified SecurityGroupId parameter is correct.
400 VpcNotFound Vpc 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.
400 InvalidSystemDiskSize.ImageNotSupportResize The specified image does not support resize. The specified image does not support resizing.
400 InvalidSpotInterruptionBehavior %s The specified SpotInterruptionBehavior parameter is not supported.
400 InvalidDeploymentOnHost %s The instance cannot be deployed in the specified deployment set.
400 InvalidInstanceChargeType.NotSupport The Dedicated host not support the specified Instance charge type. This dedicated host does not support instances that use the specified billing method.
400 InvalidNetworkType.NotSupported The classic networkType not support create ECS on dedicatedHost. Dedicated hosts do not support instances in the classic network type.
400 NoAvaliableDedicatedHost No available dedicated host or not enough resource on dedicated host. No available dedicated host was found.
400 InvalidDedicatedHostId.NotFound The specified DedicatedHostId does not exist. The specified dedicated host does not exist.
400 InvalidDedicatedHostStatus.NotSupport Operation denied due to dedicated host status. The current status of the dedicated host does not support this operation.
400 IncorrectDedicatedHostStatus The current status of the resource does not support this operation. The resource is in a state that does not support the current operation.
400 ChargeTypeViolation.PostPaidDedicatedHost Prepaid instance onto postpaid dedicated host is not allowed. A subscription instance cannot be added to a pay-as-you-go dedicated host.
400 DedicatedHostType.Unmatched The specified DedicatedHostType doesn?t match the instance type. The specified dedicated host type does not match the instance type.
400 InvalidParam.NetworkInterface %s The specified parameter is invalid. Check whether the parameter corresponds to the operation.
400 InvalidParams.CreateEniParams %s
400 InvalidParameter.CreditSpecification The specified CreditSpecification is not supported in this region. The running mode of the specified burst performance instance is not supported in this zone.
400 IncorrectVpcStatus Current VPC status does not support this operation. The VPC is in a state that does not support the current operation.
400 InvalidInstanceType.NotSupported The specified instanceType is not supported by the deployment set. The current deployment set does not support the specified instance type. Try another instance type.
400 InvalidVpcZone.NotSupported The 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.
400 IncorrectDefaultVpcStatus The status of the default VPC is invalid. The state of the default VPC is invalid.
400 InvalidAutoRenewPeriod.ValueNotSupported The specified autoRenewPeriod is invalid. The specified auto-renewal duration is invalid.
400 InvalidMarketImageChargeType.NotSupport The specified chargeType of marketImage is unsupported. The billing method of the Alibaba Cloud Marketplace image is not supported.
400 OperationDenied The specified instanceType or zone is not available or not authorized. Specified specifications or Availability Zones are not available
400 InvalidPeriodType.ValueNotSupported The specified parameter PeriodType is invalid. The specified PeriodType parameter is invalid.
400 IncorrectImageStatus The 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.
400 InvalidParam.Tenancy The specified Tenancy is invalid. The specified Tenancy parameter is invalid.
400 InvalidParameter.Affinity The specified Affinity is invalid.
400 InvalidCustomInstanceType.NotSupported The specified custom instance type is invalid.
400 IoOptimized.NotSupported The specified instance type must be an I/O optimized instance when the KMSKeyId parameter is specified. Please select an I/O optimized instance type and try again.
400 InvalidSnapshotId.Malformed The specified SnapshotId is not valid. The specified SnapshotId is invalid.
400 InvalidCapacityReservationId.NotFound The specified CapacityReservationId does not exist.
400 LackResource There's no enough resource on the specified capacity reservation.
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. The specified tag key already exists. Tag keys must be unique.
400 InvalidSecurityGroup.NetworkType %s
400 InvalidSecurityGroup.VpcMismatch %s
400 InvalidParameter.SecurityGroupIdRepeated %s The security group ID passed in is duplicate.
400 InvalidSecurityGroupId.SingleIdAndMultiIdConflict %s
400 InvalidSecurityGroupId.MultiGroupIdNetworkTypeConflict %s
400 JoinedGroupLimitExceed %s The 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.
400 InvalidAccountStatus.PayAmountLimitExceeded Your account is being restricted, because you have no default payment method or you are not authorized.
400 InvalidPerformanceLevel.Malformed The specified parameter DataDisk.n.PerformanceLevel is not valid. The specified PerformanceLevel parameter is invalid.
400 InvalidOperation.EniCountExceeded The maximum number of eni in a enterprise security group is exceeded. The number of ENIs in the advanced security group has reached the upper limit.
400 QuotaExceeded.PrepayDataDiskCapacity The quota of prepay data disk capacity exceeds.
400 InvalidDiskCategory.ConflictSnapshotCategory The specified disk category conflict with snapshot category.
400 AccountForbidden.ProductCreationLimited The commodity must be officially operated by Aliyun and in pay-as-you-go billing method. Enterprise cloud migration customers can purchase only pay-as-you-go ECS instances and cannot purchase third-party products such as images provided by Alibaba Cloud Marketplace. Check the parameters and retry with valid parameters.
400 UnexpectedImageFamily.ImageIdSupplied The input parameter ImageFamily must be null when image id is set. The ImageFamily parameter must be left empty if an image ID is specified.
400 InvalidEncrypted.NotMatchEncryptAlgorithm The Encrypted parameter must be set to true when EncryptAlgorithm is specified. Please adjust the parameters and try again.
400 InvalidEncrypted.NotMatchKmsKeyId The Encrypted parameter must be set to true when KMSKeyId is specified. Please adjust the parameters and try again.
400 InvalidEncryptAlgorithm.NotMatchSnapshot The specified parameter EncryptAlgorithm is different from the encrypt algorithm of the snapshot.
400 InvalidKmsKeyId.NotMatchSnapshot The specified parameter KmsKeyId is different from the KmsKeyId of the snapshot.
400 InvalidEncryptAlgorithm The specified EncryptAlgorithm is not valid. Ensure the value is a supported encryption algorithm such as AES-256.
400 InvalidHttpEndpoint.NotSupported The 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.
400 InvalidHttpTokens.NotSupported The 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.
400 InvalidHttpPutResponseHopLimit.NotSupported The 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.
400 InvalidOperation.VpcHasEnabledAdvancedNetworkFeature The specified vpc has enabled advanced network feature. Advanced features are enabled for the specified VPC. You cannot create low-specification instances in the VPC.
400 InvalidChargeType.CapacityReservationNotSupported %s
400 InvalidPerformanceLevel.ValueNotSupported The current ZoneId or InstanceType does not support PL0 of cloud_essd.
400 InvalidKMSKeyId.NotSymmetric The specified KMSKeyId must be a symmetric key. Please use a symmetric KMS key such as an AES-256 key.
400 InvalidParameter.Arns The specified Arns is not valid. The Arns parameter is invalid. Please check and pass it again.
400 InvalidDedicatedHostClusterId.NotFound The specified DedicatedHostClusterId does not exist.
400 InvalidDedicatedHostClusterId.InValid The specified Dedicated Host Cluster is invalid.
400 InvalidDeploymentSetId.NotFound The parameter DeploymentSetId is invalid.
400 InvalidOperation.UserNotSupported Reseller user do not support purchase at the moment.
400 InvalidManagedPrivateSpaceId.NotFound %s
400 InvalidSchedulerOptions The specified parameter SchedulerOptions is not valid.
400 MissingParameter.PrivatePoolOptionsId The specified PrivatePoolOptions.Id should not be null. The PrivatePoolOptions.Id parameter is required.
400 Invalid.PrivatePoolOptionsId The specified PrivatePoolOptions.Id is invalid. The specified PrivatePoolOptions.Id parameter is invalid.
400 DedicatedHostNotSupported DedicatedHost is not supported for PrivatePool. The private pool does not support dedicated hosts.
400 SpotNotSupported Spot is not supported for PrivatePool. The private pool does not support spot instances.
400 ClassicNetworkNotSupported Classic network is not supported for PrivatePool. The private pool does not support instances in the classic network.
400 Invalid.InstanceId Instance does not exist. The specified instance does not exist.
400 Invalid.PrivatePoolOptions.MatchCriteria Target mode does not support this operation. The operation is not supported while the PrivatePoolOptions.MatchCriteria parameter is set to Target.
400 MissingParameter.PrivatePoolOptions.Id The specified PrivatePoolOptions.Id should not be null. The PrivatePoolOptions.Id parameter is required.
400 Invalid.PrivatePoolOptions.Id The PrivatePool does not exist. The private pool does not exist.
400 Invalid.InstanceType The InstanceType does not match the PrivatePool. The instance type and the private pool do not match.
400 Invalid.InstanceChargeType The InstanceChargeType does not match the PrivatePool. The instance billing method and the private pool do not match.
400 Invalid.ZoneId The ZoneId does not match the PrivatePool. The zone and the private pool do not match.
400 Invalid.PrivatePoolOptions.NoStock The PrivatePool has been used up. The capacity of the specified private pool (elastic assurance, capacity reservation) has been used up.
400 InvalidPlatform.ValueNotSupported The Platform does not match the PrivatePool. The specified Platform parameter does not match the private pool.
400 Invalid.PrivatePoolOptions.status The PrivatePool is expired or inactive. The private pool has expired or is not activated.
400 InvalidAliUid The 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.
400 InvalidBandwidthOut.LessThanZero The bandwidth must be larger than 0 when specifying isp.
400 HibernationConfigured.InstanceTypeNotSupport The specified instance type is not support.
400 HibernationConfigured.ImageNotEncrypted The hibernation configured instance only support encrypted image.
400 HibernationConfigured.MemorySizeTooBig The hibernation configured instance memory size is too big.
400 InvalidSystemDiskSize.LessThanMemSize The specified parameter SystemDisk.Size is less than the memory size.
400 InvalidCloudBoxZone.OperationNotSupported The cloud box zone does not support creating prepaid or encrypted resources.
400 ProvisionedIopsForDiskCategoryUnsupported The specified disk category does not support provisioned iops. The specified disk type does not support provisioned IOPS.
400 InvalidProvisionedIops.LimitExceed The provisioned iops exceeds the limit. The filled ProvisionedIops parameter exceeds the limit.
400 BurstingEnabledForDiskCategoryUnsupported The specified disk category does not support bursting enabled. The specified disk type does not support the performance burst feature.
400 BurstingEnabledForMultiAttachDiskUnsupported The multi attach disk does not support bursting enabled. Multi-attach disks do not support the performance burst feature.
400 ProvisionedIopsForDiskCategoryRequired The provisioned iops is required for this disk category. Provisioned IOPS must be specified for this disk type.
400 NotSupportSnapshotEncrypted.InstanceType The specified instance type does not support re-encrypting a disk with a new KMSKeyId from a snapshot. Please select another instance type.
400 NotSupportSnapshotEncrypted.RegionId The specified region does not support creating encrypted disks with native snapshot encrypt.
400 NotSupportSnapshotEncrypted.ZoneId The specified zone does not support creating encrypted disks with native snapshot encrypt.
400 NotSupportSnapshotEncrypted.ShareImage Shared 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.
400 NotSupportSnapshotEncrypted.ImageOwnerAlias The specified image category does not support creating encrypted disks with native snapshot encrypt. This image type does not support creating an encrypted disk with a different image encryption key.
400 NotSupportSnapshotEncrypted.DiskCategory The specified disk category does not support re-encrypting a disk with a new KMSKeyId from a snapshot. Please use a disk category that supports encryption such as cloud_essd.
400 NotSupport.SnapshotEncryptedAlgorithmConflict Changing encrypt algorithm with encrypted snapshot is not supported.
400 NoPermission.SystemTag The operator is not permission for the system tag. You are not authorized to manage the system tag.
400 NumberExceed.Tags The Tags parameter's number is exceed , Valid : 20. The number of labels specified exceeds the limit.
400 InvalidZoneId.NotSupportShareEncryptedImage Creating instances by shared encrypted images is not supported in this zone.
400 InvalidDiskCategory.NotSupported The specified disk category is not supported.
400 InvalidParameter.CloudboxNotSupported %s
400 InvalidZoneId.NotSupportCreateWithShareEncryptedImage You cannot use shared encrypted images to create instances in this zone.
400 InvalidParameter.NetworkCardIndexInvalid Invalid network card index, please check your instance type.
400 InvalidOperation.UserNotSupportNetworkCard User not support network card.
400 InvalidAccount.NotSupportSpot According to business rules, this account cannot purchase ECS Spot instances. Based on business rules, this account is not allowed to purchase ECS spot instances.
400 AccountForbidden.AssociatedWithResellerPartner Your 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. Your account is associated with a partner. Your account or the account of your associated partner is restricted from placing orders. Contact your partner to resolve the issue.
400 InvalidDestinationZone.DeploymentSetMismatch Error happened, %s. If the instance joins a deployment set with the LowLatency strategy and the deployment set already contains instances, the instance must be in the same zone as the existing instances.
400 NoPermission.Price The operation requires price permission. Please either apply for permission from your main account, or set the parameter AutoPay as true. This operation requires price permission. Please apply for permission to your master account, or set the parameter AutoPay to true for automatic payment.
400 InvalidAutoPay.PostPaidUnsupported The specified parameter AutoPay must be set as true for postpaid instance. The AutoPay parameter must be set to true for pay-as-you-go instances.
400 InvalidParam.EncryptedMismatch Creating encrypted disks from shared encrypted snapshots requires replacing the encryption key. Please set the Encrypted parameter to true.
400 InvalidParameter.DedicatedRegionNotSupported The 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
400 InvalidParameter.CpuOptionsTopologyType The specified parameter CpuOptions.TopologyType: %s is not valid. Illegal enumeration value for current CPU topology type
400 InvalidInstanceType.NotSupportCpuOptionsTopologyType The specified instance type does not support CpuOptions.TopologyType: %s. The current specification does not support the specified CPU topology type
400 InvalidEniQueueSize.RegionOrUserNotSupported The 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.
400 InvalidParameter.EniQueueSize The specified parameter TxQueueSize and RxQueueSize are not equal or exceed limit. The specified parameter TxQueueSize and RxQueueSize are not equal or exceed limit.
400 InvalidParameter.KmsNotEnabled The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again.
400 InvalidParameter.Encrypted.KmsNotEnable The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again.
400 InvalidPrivateIpAddress.Duplicated The specified private IP address is already in use. The specified IP address is already in use.
400 InvalidAdditionalInfoPvdConfig.SizeExceeded The specified parameter AdditionalInfo.PvdConfig exceeds the size.
400 InvalidParameter.Encrypted Creating non-encrypted disks from encrypted snapshots is not allowed. Please set Encrypted to true or use an unencrypted snapshot.
400 InvalidInstanceType.NotSupportHighDensityMode The 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.
400 QuotaExceeded.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.
400 InvalidParameter.CpuOptionsAccelerators The specified parameter CpuOptionsAccelerators is not valid. The current accelerator type selection is illegal
400 InvalidInstanceType.NotSupportCpuOptionsAccelerators The specified instance type does not support attach accelerator. The current instance type does not support mounting accelerators.
400 OperationDenied.TestAccountRetricted Test-account for testing has been prohibited from creating instance in this region. Please contact 400181. Test accounts are not allowed to create instances in the local region. Please contact Cost and Resource Center @ Gao Chong (400181)
400 InvalidBurstingEnabled.DiskSizeTooSmall The disk size must be greater than 3 GiB to enable burst. The disk size must be greater than 3 GiB to enable burst.
400 InvalidImage.WindowsUnsupported The specified InstanceType does not support the specified Windows image. The specified InstanceType does not support Windows image.
400 InvalidParameter.CpuOptionsTurboMode The specified parameter TurboMode is not valid. The specified parameter frequency mode is invalid
400 InvalidInstanceType.EnableNVSUnsupported The specified instance type does not support EnableNVS. The specified instance type does not support enabling the NVS feature.
400 InvalidInstanceType.EnableVISSTUnsupported The specified instance type does not support EnableVISST. The specified instance type does not support enabling the VISST feature.
400 InvalidInstanceType.EnableVRDTUnsupported The specified instance type does not support EnableVRDT. The specified instance type does not support enabling the VRDT feature.
400 InvalidInstanceType.SingleCoreMaxModeUnsupported The specified instance type does not support TurboMode: "SINGLE CORE MAX". The specified instance type does not support single-core maximum turbo mode
400 InvalidParameter.PtpStatus The specified parameter PtpStatus: %s is not valid. The specified parameter PtpStatus: %s is not valid.
400 InvalidInstanceType.NotSupportEnablePtp The specified instance type does not support enable PTP. The specified instance type does not support enable PTP.
400 InvalidInstanceType.NetworkOptionsBandwidthWeightingUnsupported The current instance type does not support setting or modifying the BandwidthWeighting parameter. The current instance type does not support setting or modifying the BandwidthWeighting parameter.
400 InvalidParameter.NetworkOptionsBandwidthWeighting The specified parameter BandwidthWeighting is not valid.The correct value should be in [%s]. The specified parameter BandwidthWeighting is not valid.The correct value should be in [%s].
400 InvalidMarketImage.NotAuthorized The specified marketplace image is not authorized for your channel, please use other image. The specified marketplace image is not authorized for your channel, please use other image.
400 InvalidParameter.CpuOptionsNestedVirtualization The specified parameter CpuOptions.NestedVirtualization: %s is not valid.
400 InvalidInstanceType.NotSupportCpuOptionsNestedVirtualization The specified instance type does not support CpuOptions.NestedVirtualization: %s. The specified instance type does not support CpuOptions.NestedVirtualization value.
400 InvalidManagedHostId.DedicatedHostIdConflict The parameters 'ManagedHostId' and 'DedicatedHostId' cannot be specified at the same time. Cannot specify ManagedHostId and DedicatedHostId at the same time
400 InvalidManagedHostId.ManagedPrivateSpaceIdConflict The parameters 'ManagedHostId' and 'ManagedPrivateSpaceId' cannot be specified at the same time. Cannot specify ManagedHostId and ManagedPrivateSpaceId at the same time
400 InvalidManagedHostId.TenancyConflict The specified parameter 'ManagedHostId' requires 'Tenancy' to be 'managedHost'. Specified ManagedHostId Only Tenancy can be specified as managedHost or no Tenancy can be specified
401 InvalidRamRole.NotEcsRole The 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.
500 InternalError The request processing has failed due to an internal error and you may retry later or contact support with the request ID.
500 InvalidStorageClusterId.CategoryNotMatch The current dedicated storage cluster cannot create this category of disk.
500 InvalidStorageClusterId.DiskPoolRequired The specified disk category can only be created in a disk pool.
500 InvalidStorageClusterId.NotExist The specified StorageClusterId does not exist in current region.
403 OperationDenied.CashCouponsInsufficientOrExpired Cash coupon balance is insufficient or has expired, please retry.
403 InvalidParameter.PrivateIpAddressRepeated %s
403 InvalidOperation.HighPerformanceEniPerInstanceLimitExceeded %s
403 InvalidParameter.EniNumExceededWithLaunchEcs %s
403 InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode %s The instance type of the specified instance does not support the NIC of the RDMA communication mode.
403 InvalidParameter.QueuePairNumberMustEmpty %s
403 InvalidParameter.EniTrafficMode %s
403 InvalidParameter.InvalidQueuePairNumber The parameter of QueuePairNumber is invalid.
403 InvalidParam.IpCount The parameter of ip count is invalid.
403 InvalidParameter.EniType %s
403 InvalidOperation.HighPerformanceTrafficModeIsNotAllowed %s
403 InvalidParameter.NetworkInterface %s
403 InvalidParameter.Combination %s The specified parameter combination is invalid.
403 InvalidHostname.SingleAndMultiConflict %s
403 InvalidHostname.SizeInvalid %s
403 InvalidParams.InstanceNameExceed The 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.
403 InvalidParams.HostnameExceed The 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.
403 ImageNotSubscribed The specified image has not be subscribed.
403 InvalidSystemDiskCategory.ValueUnauthorized The disk category is not authorized. You are not authorized to use the specified disk category.
403 InvalidSnapshotId.NotReady The specified snapshot has not completed yet.
403 InstanceDiskCategoryLimitExceed The 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.
403 InvalidDevice.InUse The specified device has been occupied.
403 ImageRemovedInMarket The 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.
403 CategoryNotSupported The specified zone does not offer the specified disk category.
403 QuotaExceed.PortableCloudDisk The quota of portable cloud disk exceeds.
403 SecurityGroupInstanceLimitExceed Exceeding the allowed amount of instances of a security group.
403 NodeControllerUnavailable The Node Controller is temporarily unavailable.
403 RegionUnauthorized There is no authority to create instance in the specified region. You are not authorized to create instances in the specified region.
403 InvalidSnapshotId.NotDataDiskSnapshot The specified snapshot is system disk snapshot.
403 Forbbiden User not authorized to operate on the specified resource. You are not authorized to operate the specified resource.
403 DeleteWithInstance.Conflict The specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute.
403 InstanceDiskNumLimitExceed The number of specified disk in an instance exceeds. The number of specified disks exceeds the upper limit for an instance.
403 IoOptimized.NotSupported The specified image is not support IoOptimized Instance.
403 InvalidDiskSize.TooSmall Specified disk size is less than the size of snapshot.
403 InvalidDiskCategory.Mismatch The specified disk categories combination is not supported.
403 InvalidDiskCategory.NotSupported The specified disk category is not support the specified instance type.
403 QuotaExceed.BuyImage The specified image is from the image market?You have not bought it or your quota has been exceeded.
403 InvalidResourceId.NotSupported The specified ResourceId does not support tagging.
403 OperationDenied The 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.
403 OperationDenied.ImageNotValid The specified Image is disabled or is deleted.
403 OperationDenied.SnapshotNotValid The specified snapshot is not allowed to create disk.
403 OperationDenied.SnapshotNotAllowed The specified snapshot is not allowed to create disk.
403 OperationDenied.ZoneNotAllowed The creation of Instance to the specified Zone is not allowed.
403 OperationDenied.ZoneSystemCategoryNotMatch The specified Zone or cluster does not offer the specified disk category or the speicified zone and cluster do not match.
403 OperationDenied.ResourceControl The specified region is in resource control, please try later. The specified region is under resource control. Try again later.
403 OperationDenied.NoStock The resource is out of usage.
403 OperationDenied.SnapshotParamsNotValid The capacity of snapshot exceeds the size limit of the specified disk category or the specified category is not authorizied.
403 OperationDenied.DiskTypeNotSupport The type of the disk does not support the operation.
403 InvalidUserData.Forbidden User not authorized to input the parameter "UserData", please apply for permission "UserData".
403 Zone.NotOpen The specified zone is not granted to you to buy resources yet.
403 Zone.NotOnSale The resource in the specified zone is no longer available for sale. Please try other regions and zones. The specified zone is sold out. Change the instance type or create the instance in a different region.
403 InvalidClusterId.NotFound The specified clusterId does not exist. The specified ClusterId parameter does not exist.
403 InvalidResourceType.NotSupported %s The specified resource combination does not exist. Change to another zone or specification.
403 InvalidInstanceType.ValueNotSupported The specified InstanceType beyond the permitted range.
403 InvalidInstanceType.ZoneNotSupported The specified zone does not support this instancetype. The specified instance type is not supported in the specified zone.
403 InstanceType.Offline %s The operation is not supported while the instance type is retired or while resources of the instance type are insufficient.
403 DependencyViolation.WindowsInstance The 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.
403 InvalidNetworkType.MismatchRamRole A RAM role can?t be used for classic instance.
403 InvalidUser.PassRoleForbidden The RAM user does not have the privilege to pass a RAM role. The RAM user is not authorized to pass a RAM role.
403 InvalidParam.TrustedSystemMode The specified TrustedSystemMode is invalid.
403 InvalidParam.ConfidentialComputingMode The specified ConfidentialComputingMode is invalid.
403 InvalidInstanceType.NotSupported The specified instance type does not support trusted system. The specified InstanceType is not supported.
403 InvalidSecurityOptions.NotSupported SecurityOptions for vTPM and Enclave can not both be set.
403 InvalidImage.NotSupported The specified vTPM instance need UEFI image. The specified virtual TPM instance requires a UEFI image.
403 Forbidden.RiskControl This operation is forbidden by Aliyun RiskControl system. The operation is forbidden by the risk control system.
403 InvalidInstance.UnPaidOrder The specified Instance has unpaid order.
403 Account.Arrearage Your account has been in arrears.
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. You have not completed real-name verification. Complete real-name verification and try again.
403 InvalidPayMethod The specified pay method is not valid.
403 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance.
403 ImageNotSupportInstanceType The specified image does not support the specified InstanceType. The specified image does not support the specified instance type.
403 DryRun.InvalidAmount %s
403 OperationDenied.InvalidNetworkType %s The network type does not support this operation.
403 InvalidSpotInterruptionBehavior.ClassicNetworkNotSupport The specified SpotInterruptionBehavior does not support Classic network Instance. This operation does not support instances of the classic network type.
403 InvalidSpotInterruptionBehavior.LocalDiskNotSupport The specified SpotInterruptionBehavior does not support local disk instance. This operation does not support instances with local disks.
403 QuotaExceed.PostPaidDisk Living postPaid disks quota exceeded. The number of pay-as-you-go disks has exceeded the allowed quota.
403 InvalidParameter.NotMatch %s A specified parameter is invalid. Check whether parameter conflicts exist.
403 InvalidVSwitch.DefaultVSwitchNotSupport The specified zone in vpc can't support create default vSwitch.
403 OperationDenied.LocalDiskUnsupported The 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.
403 OperationDenied.InconsistentNetwork The specified security group and vswitch are not in the same vpc. The specified security group and vSwitch do not belong to the same VPC.
403 DefaultVswitch.Existed The default vswitch for VPC already exists. A default vSwitch already exists in the current VPC.
403 IncorrectInstanceStatus The current status of the resource does not support this operation.
403 CategoryViolation The specified instance does not support this operation because of its disk category.
403 ResourcesNotInSameZone The specified instance and dedicated host are not in the same zone. The specified disk and instance are not in the same zone.
403 InvalidDisk.SystemDiskSize The specified SystemDiskSize beyond the permitted range. The specified system disk size exceeds the maximum allowed value.
403 InsufficientBalance Your account does not have enough balance.
403 InvalidOperation.NetworkInterface %s
403 MaxEniIpv6IpsCountExceeded %s The maximum number of IPv6 addresses that can be assigned to the ENI has been reached.
403 InvalidIp.IpRepeated %s The specified IP address already exists.
403 InvalidIp.IpAssigned %s The specified IP address is already assigned.
403 InvalidIp.Address %s The IP entered is not in the correct format or is not in the optional CIDR range.
403 InvalidOperation.EniCountExceeded %s
403 InvalidOperation.Ipv4CountExceeded %s The operation is valid because the maximum number of IPv4 addresses has been reached.
403 InvalidOperation.Ipv6CountExceeded %s The operation is valid because the maximum number of IPv6 addresses has been reached.
403 InvalidOperation.Ipv6NotSupport %s IPv6 does not support the current operation.
403 InvalidOperation.Ipv4NotSupport %s
403 InvalidParam.SecondaryIp %s
403 InvalidVSwitch.Ipv6NotTurnOn %s The IPv6 feature is not enabled for your current vSwitch. Enable the feature and try again.
403 InvalidParam.IpAssign %s
403 InvalidParam.Amount %s The specified Amount parameter is invalid.
403 InvalidParam.CpuOptionsCore %s The specified number of physical CPU cores is invalid.
403 InvalidParam.CpuOptionsNuma %s
403 InvalidVSwitchId.IpInvalid %s The specified private IP address is invalid.
403 Forbidden.RegionId %s
403 QuotaExceed.DeploymentSetInstanceQuotaFull The instance quota in one deployment set exceeded. The number of instances in the current deployment set has reached the maximum limit.
403 InvalidChargeType.ValueNotSupported Deletion 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.
403 InvalidRegion.NotSupport The specified region does not support byok. The bring your own key (BYOK) feature is not supported in the region.
403 UserNotInTheWhiteList The 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.
403 InvalidParameter.KMSKeyId.KMSUnauthorized The ECS service is not authorized to access your KMS key. Please grant the ECS service permission to use the key and try again.
403 SecurityRisk.3DVerification We have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email. A security risk has been detected on your default credit or debit card. Verify your identity by using the link in the email.
403 Mayi.InternalError The request processing has failed due to an internal error and you may retry later or contact support with the request ID.
403 InvalidNetworkType The network type is not support in this region. The network type NetworkType entered is no longer supported.
403 InvalidAccountStatus Your account status is invalid, please contact customer service.
403 QuotaExceeded.PrivateIpAddress %s The internal IP address of the specified switch VSwitch is insufficient.
403 OperationDenied.PerformanceLevelNotMatch The specified DataDisk.n.PerformanceLevel and DataDisk.n.Size do not match.
403 InvalidStorageSetName.Malformed Specified parameter StorageSetName is not valid.
403 InvalidDescription.Malformed Specified parameter Description is not valid.
403 InvalidMaxPartitionNumber.Malformed Specified parameter MaxPartitionNumber is not valid.
403 InvalidParameter.StorageSetPartitionNumber Specified parameter StorageSetPartitionNumber is not valid.
403 InvalidParameter.StorageSetId Specified parameter StorageSetId is not valid.
403 InvalidParameter.StorageSetZoneId Specified parameter StorageSetZoneId is not valid.
403 EnterpriseGroupLimited.MutliGroupType The specified instance can't join multi SecurityGroup types. The specified instance cannot be added to multiple types of security groups.
403 EnterpriseGroupLimited.InstanceType The specified instance type doesn't support Enterprise SecurityGroup.
403 QuotaExceed.Tags %s The number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
403 OperationDenied.RegionIdNotSupported The specified region does not support spot duration instance.
403 OperationDenied.FlavorNotSupported Flavor not support spot duration instance.
403 OperationDenied.TimestampNotSupported Timestamp not support spot duration instance.
403 OperationDenied.PaygNotAvailable Pay-as-you-go instance is not available now.
403 OperationDenied.PrepayNotAvailable Prepay instance is not available now.
403 OperationDenied.BidOwnResource Bid user can not own resource.
403 OperationDenied.CloudSSDNotSupported The specified available zone does not offer the cloud_ssd disk, use cloud_essd instead. The specified zone does not support cloud_ssd disks. Use cloud_essd disks and try again.
403 QuotaExceed.ElasticQuota No 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.
403 QuotaExceeded.PostpaidDataDiskCapacity The quota of postpaid data disk capacity exceeds. The used capacity of the pay-as-you-go disk reaches the quota limit.
403 InvalidImageFamily.MissingAvailableImage There is no available image related to the specified image family.
403 InvalidRegionId.NotSupportEncryptAlgorithm The current region does not support creating encrypted disks with EncryptAlgorithm.
403 InvalidOperation.ResourceManagedByCloudProduct %s You cannot modify security groups managed by cloud services.
403 InvalidManagedPrivateSpaceId.DedicatedHostIdConflict ManagedPrivateSpaceId and DedicatedHostId cannot be specified at the same time.
403 InvalidManagedPrivateSpaceId.TenancyConflict ManagedPrivateSpaceId and Tenancy cannot be specified at the same time.
403 InvalidParameter.InvalidEniQueueNumber %s The number of Elastic Network Interface (ENI) queues on the network interface controller (NIC) is incorrect. For more information, see the actual return result of the %s placeholder in the error message.
403 InvalidOperation.MaxEniQueueNumberExceeded %s The number of Elastic Network Interface (ENI) queues on the network interface controller (NIC) exceeds the upper limit. For more information, see the actual return result of the %s placeholder in the error message.
403 InvalidOperation.ExceedInstanceTypeQueueNumber %s The 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.
403 InvalidIspType.ValueNotSupported %s
403 UnsupportedIspChargeType %s The billing type does not support the service provider (ISP) for this account.
403 UnsupportedIspClassicNetwork %s
403 InvalidIspBandwidthOut %s
403 UnsupportedIspNetworkChargeType %s
403 InvalidIspUID %s
403 UnsupportedIspRegion %s
403 Forbidden.OnlySupportEnterpriseGroup %s
403 HibernationConfigured.InstanceOperationForbidden The 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.
403 InstanceDiskLimitExceeded The amount of the disk on instance reach its limits. The specified instance has reached the maximum number of disks that can be attached.
403 InvalidInstanceType.NotSupportDiskCategory The 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.
403 InvalidOperation.ConfidentialComputingModeInInviteOnlyTesting The specified confidential computing mode is in invite only testing: %s. The specified confidential computing mode is currently in the invitation-based testing phase.
403 InvalidOperation.InvalidNetworkInterfaceId %s
403 InvalidOperation.RegionNotSupportNetworkInterfaceId The specific region does not support network interface id.
403 InvalidEniId.NotFound %s The specified ENI ID does not exist.
403 NotSupportSnapshotEncrypted.DiskCategory The specified disk category does not support re-encrypting a disk with a new KMSKeyId from a snapshot. Please use a disk category that supports encryption such as cloud_essd.
403 InvalidOperation.PublicIpAddressNoStock The 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.
403 AclLimitExceed %s The number of ACL rules for an ENI or instance exceeds the upper limit.
403 InvalidParameter.DataEncryptedKeyCreateFailed The ECS service is not authorized to access your KMS key. Please grant the ECS service permission to use the key and try again.
403 InvalidParameter.CpuOptionsThreadsPerCore The specified parameter CpuOptions.ThreadsPerCore is not valid. The specified parameter CpuOptions.ThreadsPerCore is not valid.
403 InvalidParameter.CpuOptionsCore The specified parameter CpuOptions.Core is not valid. The specified parameter CpuOptions.Core is not valid.
403 InvalidInstanceType.CpuOptionsThreadsPerCoreUnsupported The current instance type does not support setting or modifying the CpuOptions.ThreadsPerCore parameter. The current instance type does not support setting or modifying the CpuOptions.ThreadsPerCore parameter.
403 InvalidParameter.CpuOptionsNuma The specified parameter CpuOptions.Numa is not valid. The specified parameter CpuOptions.Numa is not valid.
403 InvalidParameter.KMSKeyId.CMKUnauthorized The specified KMS key is not authorized for the ECS service. Please grant the ECS service permission to use the key in the KMS console and try again.
403 InvalidParameter.KMSKeyId.CMKNotEnabled The specified KMS key must be in an enabled state. Please enable the key in the KMS console and try again.
403 InvalidEncrypted.NotMatchSnapshot The Encrypted parameter must be set to true when creating disks from encrypted snapshots. Please set Encrypted to true or use an unencrypted snapshot.
403 InvalidEncrypted.NotMatchDiskDefaultEncryption The operation failed because default disk encryption is enforced on your account. Please set the Encrypted parameter to true.
403 InvalidOperation.InstanceTypeNotSupportNetworkEncryption The specified instance type does not support network encryption. the specified instance type does not support vpc traffic encryption
403 InvalidOperation.UserNotSupportNetworkEncryption User not support network encryption. The user does not support specifying network traffic encryption parameters.
403 InvalidOperation.InstanceTypeNotSupportEniTrunking The current instance type does not support ENI trunking operation. The current instance type does not support ENI trunking operation.
403 InvalidOperation.ImageSecureBootUnsupported The image does not support secure boot. The mirror does not support secure boot.
403 InvalidOperation.InstanceTypeSecureBootUnsupported The instance type does not support secure boot. The instance type does not support secure boot.
403 InvalidOperation.SecureBootRegionNotSupported Secure Boot is not available in the specified region. The current region does not support enabling Secure Boot.
403 OperationDenied.KMSKeyUnauthorized The operation is denied due to missing KMS key authorization. Please check the KMS key permissions and ensure the key is properly authorized for this operation.
404 InvalidStorageClusterId.NotExist The specified StorageClusterId does not exist in current region. The specified storage cluster ID does not exist in the current region.
404 InvalidRegionId.NotFound The RegionId provided does not exist in our records. Region information error
404 InvalidZoneId.NotFound The ZoneId provided does not exist in our records.
404 InvalidSecurityGroupId The specified SecurityGroupId is invalid or does not exist. The specified security group ID is invalid or does not exist.
404 InvalidSecurityGroupId.NotFound The 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.
404 InvalidDataDiskSnapshotId.NotFound The specified parameter "DataDisk.n.SnapshotId" is not valid.
404 InvalidClusterId.NotFound The ClusterId provided does not exist in our records.
404 InvalidVSwitchId.NotFound Specified virtual switch does not exist. The specified vSwitch ID does not exist.
404 InvalidImageId.NotFound The specified ImageId does not exist. The specified image does not exist in this account. Check whether the image ID is correct.
404 IoOptimized.NotSupported The specified instancetype is not support IoOptimized instance.
404 InvalidInstanceChargeType.NotFound The InstanceChargeType does not exist in our records.
404 DependencyViolation.IoOptimized The specified instancetype must be IoOptimized instance.
404 PaymentMethodNotFound No payment method has been registered on the account.
404 HOSTNAME_ILLEGAL The specified parameter HostName is not valid.
404 InvalidSystemDiskSize.LessThanImageSize The specified parameter SystemDisk.Size is less than the image size.
404 InvalidSystemDiskSize.LessThanMinSize The specified parameter SystemDisk.Size is less than the min size.
404 InvalidSystemDiskSize.MoreThanMaxSize The specified parameter SystemDisk.Size is more than the max size. The specified SystemDisk.Size value is greater than the upper limit.
404 OperationDenied.ImageNotValid The specified Image is disabled or is deleted. The specified image does not exist.
404 OperationDenied.CreatingConflict Another Instance has been creating.
404 InvalidKeyPairName.NotFound The specified parameter KeyPairName does not exist in our records.
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records. The specified resource group does not exist.
404 InvalidRamRole.NotFound The specified parameter "RAMRoleName" does not exist. The specified RamRoleName does not exist.
404 InvalidLaunchTemplate.NotFound %s The specified launch template does not exist. Check whether the parameter value is correct.
404 InvalidLaunchTemplateVersion.NotFound %s The specified version of the launch template does not exist. Check whether the parameter values are correct.
404 InvalidVSwitchId.NotExist %s The specified vSwitch does not exist.
404 InvalidMarketImage.NotFound The 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.
404 DeploymentSet.NotFound The specified deployment set does not exist. The specified deployment set does not exist.
404 InvalidParameter.DeploymentSetGroupNo Parameter DeploymentSetGroupNo is invalid.
404 InvalidParameter.KMSKeyId.NotFound The specified KMSKeyId does not exist. Please verify that the key ID is correct and that the key resides in the current region.
404 InvalidDiskIds.NotPortable The specified DiskId is not portable.
404 InvalidAutoSnapshotPolicyId.NotFound Specified parameter AutoSnapshotPolicyId not found. The specified automatic snapshot policy does not exist.
429 Throttling.Resource The request throttle by resource operation. Request is controlled by resource operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.