All Products
Search
Document Center

Elastic Compute Service:CreateInstance

Last Updated:Apr 11, 2024

Creates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance.

Operation description

Usage notes

Note You can call the DescribeAvailableResource operation to query available resources in a specific region or zone. If you want to batch create instances that automatically enter the Running state after they are created, we recommend that you call the RunInstances operation.

Take note of the following items:

  • Billing:

    • You must familiarize yourself with ECS billing methods before you create an instance because you may be charged for the resources used by the instance. For more information, see Billing overview.
    • If you create a subscription instance (PrePaid), available coupons in your account are used by default.
  • Instance type:

Note If the QuotaExceed.ElasticQuota error is returned when you call this operation, it indicates that the maximum number of instances of the specified instance type in the region has been reached, or the maximum number of vCPUs for all instance types in a zone has been reached. You can go to the ECS console or Quota Center to request a quota increase.
  • Image:

    • The image determines the system disk configurations of the new instance. The system disk of the new instance is a clone of the specified image.
    • If you want to create instances with 512 MiB of memory, you cannot use Windows Server images except for Windows Server Semi-Annual Channel images.
    • If you want to create instances with 4 GiB or more of memory, you cannot use 32-bit OS image.
  • Network type:

    • Each instance that resides in a virtual private cloud (VPC) must be connected to only a single vSwitch.
    • If VSwitchId is specified, the security group specified by SecurityGroupId and the vSwitch specified by VSwitchId must belong to the same VPC.
    • The value of PrivateIpAddress varies based on the value of VSwitchId. PrivateIpAddress cannot be separately specified. If VSwitchId and PrivateIpAddress are specified, the IP address specified by PrivateIpAddress must be an idle IP address in the CIDR block of the specified vSwitch.
  • Public bandwidth:

    • Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the bandwidth limit, submit a ticket. The throttling policy imposes the following constraints: In a single region, the total maximum bandwidth value of all instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total maximum bandwidth value of all instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
    • If you call the CreateInstance operation to create an instance, no public IP addresses are assigned to the instance. You can call the AllocatePublicIpAddress operation to assign a public IP address to an instance.
    • Network usage fees vary based on the settings of InternetChargeType and InternetMaxBandwidthOut.
    • The value of InternetMaxBandwidthIn does not affect billing because inbound data traffic is free of charge.
    • If InternetChargeType is set to PayByBandwidth, InternetMaxBandwidthOut specifies the fixed bandwidth. A fixed bandwidth is a specified amount of public bandwidth allocated to an instance that uses the pay-by-bandwidth billing method for network usage.
    • If InternetChargeType is set to PayByTraffic, InternetMaxBandwidthOut specifies the peak bandwidth. A peak bandwidth is the maximum amount of public bandwidth that an instance can consume when the instance uses the pay-by-traffic billing method for network usage. Network usage costs are calculated based on the volume of network traffic.
  • Security group:

    • If no security groups are available in the region where you want to create an instance, you must call the CreateSecurityGroup operation to create a security group in that region first.
    • The maximum number of instances that a security group can contain varies based on the security group type. For more information, see the "Security group limits" section in the Limits topic.
    • Instances in the same security group can communicate with each other over the internal network. By default, instances in different security groups cannot communicate with each other. You can allow communication between instances by allowing mutual access between the security groups to which the instances belong. For more information, see AuthorizeSecurityGroup and AuthorizeSecurityGroupEgress .
  • Storage:

    • The instance is assigned a system disk whose capacity varies based on the size of the specified image. The size of the system disk must be at least 20 GiB and greater than or equal to the image size. For information about system disk categories, see the description of SystemDisk.Category.
    • The system disk of an I/O optimized instance can only be an enhanced SSD (ESSD) (cloud_essd), a standard SSD (cloud_ssd), or an ultra disk (cloud_efficiency).
    • The maximum size of a data disk varies based on the disk category. For more information, see the description of DataDisk.N.Size.
    • Up to 16 data disks can be added to an instance. Mount points /dev/xvd[b-z] are automatically assigned to data disks in ascending alphanumeric order.
Note If the QuotaExceed.DiskCapacity error is returned when you call this operation, it indicates that the maximum capacity of the disks of the selected disk category in the specified zone has been reached. You can go to the Quota Center to query and request a quota increase.
  • User data: If the instance type supports user data, you can use the UserData parameter to pass in user data. User data is encoded in Base64. We recommend that you do not pass in confidential information (such as passwords or private keys) in plaintext as user data. This is because the system does not encrypt UserData values when API requests are transmitted. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64 before you pass in the information. Then decode and decrypt the information in the same way within the instance.
  • Others: When you call API operations by using Alibaba Cloud CLI or SDKs, you must delete periods (.) from some request parameters before you use the parameters. For example, use SystemDiskCategory instead of SystemDisk.Category as a request parameter.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ImageIdstringNo

The ID of the image to use to create the instance. To use an Alibaba Cloud Marketplace image, you can view the image ID on the product page of the Alibaba Cloud Marketplace image. This parameter is required if you do not specify ImageFamily to obtain the latest available custom image from the specified image family.

ubuntu_18_04_64_20G_alibase_20190624.vhd
ImageFamilystringNo

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

  • ImageFamily must be empty if ImageId is specified.
  • ImageFamily can be specified if ImageId is not specified.
hangzhou-daily-update
InstanceTypestringYes

The instance type.

ecs.g6.large
SecurityGroupIdstringNo

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

sg-bp15ed6xe1yxeycg****
InstanceNamestringNo

The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). If you do not specify this parameter, the instance ID is used as the instance name by default.

2018-12-06T103200Z
InternetChargeTypestringNo

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

  • PayByBandwidth: pay-by-bandwidth
  • PayByTraffic (default): pay-by-traffic
Note When the pay-by-traffic billing method is used for network usage, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidth values may be limited. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage.
PayByTraffic
AutoRenewbooleanNo

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

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

The auto-renewal period of the instance. This parameter is required if AutoRenew is set to true.

Valid values if PeriodUnit is set to Month: 1, 2, 3, 6, and 12.

2
InternetMaxBandwidthInintegerNo

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

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

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

Default value: 0.

5
HostNamestringNo

The hostname of the instance.

  • The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).
  • For a Windows instance, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).
  • For an instance that runs another type of operating system such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
LocalHostName
PasswordstringNo

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

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

Take note of the following items:

  • For security reasons, we recommend that you use HTTPS to send requests if the Password parameter is specified.
  • Passwords of Windows instances cannot start with a forward slash (/).
  • Passwords cannot be set for instances that run specific types of operating systems such as Others Linux and Fedora CoreOS. For these instances, only key pairs can be set.
TestEcs123!
PasswordInheritbooleanNo

Specifies whether to use the password preset in the image. When you use this parameter, leave the Password parameter empty and make sure that the selected image has a password preset.

false
DeploymentSetIdstringNo

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

ds-bp1brhwhoqinyjd6****
DeploymentSetGroupNointegerNo

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

1
ZoneIdstringNo

The ID of the zone in which to create the instance. You can call the DescribeZones operation to query the zones in a specific region.

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

This parameter is empty by default.

cn-hangzhou-g
ClusterIdstringNo

The ID of the cluster in which to create the instance.

Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.
c-bp67acfmxazb4p****
ClientTokenstringNo

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

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

The ID of the virtual LAN (VLAN).

10
InnerIpAddressstringNo

The internal IP address to assign to the instance.

192.168.**.**
SystemDisk.SizeintegerNo

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

  • Basic disks: 20 to 500.
  • Other disks: 20 to 2048.

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

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

40
SystemDisk.CategorystringNo

The category of the system disk. Valid values:

  • cloud_essd: ESSD. If SystemDisk.Category is set to this value, you can use SystemDisk.PerformanceLevel to specify the performance level of the disk.
  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD.
  • cloud: basic disk.

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

cloud_ssd
SystemDisk.DiskNamestringNo

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

This parameter is empty by default.

SystemDiskName
SystemDisk.DescriptionstringNo

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

This parameter is empty by default.

TestDescription
SystemDisk.PerformanceLevelstringNo

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

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

For information about ESSD performance levels, see ESSDs .

PL1
NodeControllerIdstringNo
Note This parameter is in invitational preview and is not publicly available.
hide
DescriptionstringNo

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

This parameter is empty by default.

InstanceTest
VSwitchIdstringNo

The ID of the vSwitch to which to connect the instance. This parameter is required when you create an instance in a VPC. You can call the DescribeVSwitches operation to query available vSwitches.

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

The private IP address to assign to the instance. The private IP address must be an available IP address in the CIDR block of the specified vSwitch.

172.16.236.*
IoOptimizedstringNo

Specifies whether the instance is I/O optimized. Valid values:

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

For retired instance types, the default value is none. For more information, see Retired instance types.

For other instance types, the default value is optimized.

optimized
UseAdditionalServicebooleanNo

Specifies whether to use the system configurations for virtual machines. Alibaba Cloud provides the Network Time Protocol (NTP) and Key Management Service (KMS) system configurations for Windows and the NTP and Yellowdog Updater, Modified (YUM) system configurations for Linux.

true
InstanceChargeTypestringNo

The billing method of the instance. Valid values:

  • PrePaid: subscription. If you set this parameter to PrePaid, make sure that you have sufficient balance or credit in your account. Otherwise, an InvalidPayMethod error is returned.
  • PostPaid (default): pay-as-you-go.
PrePaid
PeriodintegerNo

The subscription period of the instance. The unit is specified by PeriodUnit. This parameter is valid and required only when InstanceChargeType is set to PrePaid. If DedicatedHostId is specified, the value of Period must not exceed the subscription period of the specified dedicated host. Valid values:

Valid values if PeriodUnit is set to Month: 1, 2, 3, 6, and 12.

1
PeriodUnitstringNo

The unit of the subscription period. Valid values:

Month

Default value: Month.

Month
UserDatastringNo

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

ZWNobyBoZWxsbyBlY3Mh
SpotStrategystringNo

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

  • NoSpot (default): The instance is created as a regular pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is a preemptible instance for which you specify the maximum hourly price.
  • SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bid price. The market price can be up to the pay-as-you-go price.
NoSpot
KeyPairNamestringNo

The name of the key pair.

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

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

0.98
SpotDurationintegerNo

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

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

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

Note This parameter takes effect only if the SpotStrategy parameter is set to SpotWithPriceLimit or SpotAsPriceGo.
1
SpotInterruptionBehaviorstringNo

The interruption mode of the preemptible instance. The value can only be Terminate, which specifies that the instance is released.

Terminate
RamRoleNamestringNo

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

RAMTestName
SecurityEnhancementStrategystringNo

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 is applicable to all images.
Active
ResourceGroupIdstringNo

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

rg-bp67acfmxazb4p****
HpcClusterIdstringNo

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

hpc-bp67acfmxazb4p****
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and unavailable ECS resources. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, the operation is performed.
false
DedicatedHostIdstringNo

The ID of the dedicated host on which to create the instance.

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

If you specify DedicatedHostId, the SpotStrategy and SpotPriceLimit parameters are ignored. This is because preemptible instances cannot be created on dedicated hosts.

dh-bp67acfmxazb4p****
CreditSpecificationstringNo

The performance mode of the burstable instance. Valid values:

Standard
DeletionProtectionbooleanNo

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

  • true: enables release protection.
  • false (default): disables release protection.
Note This parameter is applicable only to pay-as-you-go instances. It can protect instances against manual releases, but not against automatic releases.
false
HibernationOptions.ConfiguredbooleanNo
Note This parameter is in invitational preview and is not publicly available.
false
AffinitystringNo

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

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

Default value: default.

default
TenancystringNo

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

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

Default value: default.

default
StorageSetIdstringNo

The ID of the storage set.

ss-bp1j4i2jdf3owlhe****
StorageSetPartitionNumberintegerNo

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

2
HttpEndpointstringNo

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

  • enabled
  • disabled

Default value: enabled.

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

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

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

Default value: optional.

Note For more information about the modes of accessing instance metadata, see Access mode of instance metadata.
optional
HttpPutResponseHopLimitintegerNo
Note This parameter is in invitational preview and is not publicly available.
0
PrivatePoolOptions.MatchCriteriastringNo

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

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

Default value: none.

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

  • Create a preemptible instance.
  • Create an instance in the classic network.
  • Create an instance on a dedicated host.
Open
PrivatePoolOptions.IdstringNo

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

eap-bp67acfmxazb4****
DataDiskobject []No

The data disks.

PerformanceLevelstringNo

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

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

For more information about ESSD performance levels, see ESSDs .

PL2
DescriptionstringNo

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

TestDescription
SnapshotIdstringNo

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

  • If DataDisk.N.SnapshotId is specified, DataDisk.N.Size is ignored. The data disk is created based on the size of the specified snapshot.
  • Use snapshots created on or after July 15, 2013. Otherwise, an error is returned and your request is rejected.
s-bp17441ohwka0yuh****
SizeintegerNo

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

  • Valid values if DataDisk.N.Category is set to cloud_efficiency: 20 to 32768.

  • Valid values if DataDisk.N.Category is set to cloud_ssd: 20 to 32768.

  • Valid values if DataDisk.N.Category is set to cloud_essd: vary based on the DataDisk.N.PerformanceLevel value.

    • Valid values if DataDisk.N.PerformanceLevel is set to PL0: 40 to 32768.
    • Valid values if DataDisk.N.PerformanceLevel is set to PL1: 20 to 32768.
    • Valid values if DataDisk.N.PerformanceLevel is set to PL2: 461 to 32768.
    • Valid values if DataDisk.N.PerformanceLevel is set to PL3: 1261 to 32768.
  • Valid values if DataDisk.N.Category is set to cloud: 5 to 2000.

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

2000
DevicestringNo

The mount point of data disk N.

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

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

DataDiskName
CategorystringNo

The category of data disk N. Valid values:

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

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

cloud_ssd
DeleteWithInstancebooleanNo

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

  • true: releases data disk N.
  • false: does not release data disk N.

Default value: true.

true
KMSKeyIdstringNo

The ID of the KMS key to use for data disk N.

0e478b7a-4262-4802-b8cb-00d****
EncryptAlgorithmstringNo
Note This parameter is not publicly available.
hide
EncryptedbooleanNo

Specifies whether to encrypt data disk N.

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

Default value: false.

false
StorageClusterIdstringNo

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

dbsc-j5e1sf2vaf5he8m2****
Arnobject []No
Note This parameter is in invitational preview and is not publicly available.
RoleTypestringNo
Note This parameter is in invitational preview and is not publicly available.
Primary
RolearnstringNo
Note This parameter is in invitational preview and is not publicly available.
acs:ram::123456789012****:role/adminrole
AssumeRoleForlongNo
Note This parameter is in invitational preview and is not publicly available.
1234567890
Tagobject []No

The tags.

keystringNo

The key of tag N.

Note This parameter will be removed in the future. We recommend that you use the Tag.N.key parameter to ensure future compatibility.
null
KeystringNo

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

TestKey
ValuestringNo

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

TestValue
valuestringNo

The value of tag N.

Note This parameter will be removed in the future. We recommend that you use the Tag.N.Value parameter to ensure future compatibility.
null
SystemDiskobjectNo

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

StorageClusterIdstringNo

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

dbsc-j5e1sf2vaf5he8m2****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The instance ID.

i-bp67acfmxazb4p****
OrderIdstring

The order ID. This parameter is returned only if InstanceChargeType is set to PrePaid.

1234567890
TradePricefloat

The transaction price.

0.165

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceId": "i-bp67acfmxazb4p****",
  "OrderId": "1234567890",
  "TradePrice": 0.165
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStorageClusterId.CapacityNotEnoughThe remaining capacity of the current dedicated storage cluster is less than the size of disk.The remaining capacity of the dedicated block storage cluster to which the disk belongs is insufficient.
400InvalidStorageClusterId.StatusNotSupportThe current status of the dedicated storage cluster cannot create a cloud disk yet.-
400InvalidStorageClusterId.ZoneIdEmptyThe specified param ZoneId cannot be empty when StorageClusterId given.-
400InvalidStorageClusterId.PerformanceLevelNotMatchThe current dedicated storage cluster cannot create this performance level of disk.-
400InvalidStorageClusterId.CategoryNotMatchThe current dedicated storage cluster cannot create this category of disk.-
400InvalidStorageClusterId.DiskSizeEmptyThe specified param DiskSize cannot be empty when StorageClusterId given.-
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.You are not authorized to use the specified instance type.
400InvalidInternetChargeType.ValueNotSupportedThe specified InternetChargeType is not valid.The specified InternetChargeType parameter is invalid.
400InvalidParameterThe specified parameter "InternetMaxBandwidthOut" is not valid.-
400InvalidSystemDiskCategory.ValueNotSupportedThe specified parameter " SystemDisk.Category " is not valid.-
400InvalidDataDiskSize.ValueNotSupportedThe specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.The specified DataDisk.N.Size parameter is invalid or the snapshot size exceeds the maximum capacity allowed for the specified disk category.
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType does not exist or beyond the permitted range.The specified instance type does not exist or you are not authorized to manage instances of this instance type.
400InvalidDescription.MalformedThe specified parameter "Description" is not valid.The source description can be 2 to 256 characters in length. It cannot start with http:// and https://.
400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
400InvalidPassword.MalformedThe specified parameter "Password" is not valid.-
400InvalidPasswordParam.MismatchThe input password should be null when passwdInherit is true.The Password parameter must be left empty when the PasswdInherit parameter is used.
400InvalidSystemDiskCategory.ValueNotSupportedThe specified parameter "SystemDisk.Category" is not valid.-
400InvalidDiskName.MalformedThe specified parameter "SystemDisk.DiskName or DataDisk.n.DiskName" is not valid.-
400InvalidDiskDescription.MalformedThe specified parameter "SystemDisk.DiskDescription" or "DataDisk.n.Description" is not valid.The specified SyatemDisk.DiskDescription or DataDisk.n.Description is invalid.
400InvalidDataDiskCategory.ValueNotSupportedThe specified parameter "DataDisk.n.Category" is not valid.-
400InvalidDataDevice.MalformedThe specified parameter "DataDisk.n.Device" is not valid.-
400InvalidNodeControllerId.MalformedThe specified parameter "NodeControllerId" is not valid.-
400InvalidInnerIpAddress.MalformedThe specified parameter "InnerIpAddress" is not valid.-
400InvalidInnerIpAddress.UnusableThe specified InnerIpAddress is already used or not found in usable ip range.The specified internal IP address is unavailable.
400OperationDeniedThe specified parameter "VlanId" is not valid or vlan has not enough IP address.-
400InvalidParameter.ConflictThe specified image does not support the specified instance type.The specified image cannot be used for instances of the specified instance type.
400ImageNotSupportCloudInitThe specified image does not support cloud-init.-
400InvalidSnapshotId.BasedSnapshotTooOldThe specified snapshot is created before 2013-07-15.The specified snapshot was created before July 15, 2013.
400QuotaExceed.AfterpayInstanceThe maximum number of Pay-As-You-Go instances is exceeded: %s.-
400InvalidMarketImageChargeType.NotSupportThe specified chargeType of marketImage is unsupported.The billing method of the Alibaba Cloud Marketplace image is not supported.
400InvalidInstanceName.MalformedThe specified parameter "InstanceName" is not valid.The specified InstanceName parameter is invalid.
400InvalidDiskDescription.MalformedThe specified parameter "SystemDisk.DiskDescription or DataDisk.n.Description" is not valid.-
400InvalidParameter.ConflictThe specified region and cluster do not match.The specified region and cluster do not correspond to each other.
400InvalidParameter.MismatchSpecified security group and virtual switch are not in the same VPC.The specified security group and vSwitch do not belong to the same VPC.
400InvalidNetworkType.MismatchSpecified parameter InternetMaxBandwidthIn or InternetMaxBandwidthOut conflict with instance network type.The specified InternetMaxBandwidthIn or InternetMaxBandwidthOut parameter conflicts with the instance network type.
400InvalidNetworkType.MismatchSpecified parameter "InternetChargeType" conflict with instance network type.-
400InvalidPrivateIpAddressSpecified private IP address is not in the CIDR block of virtual switch.The specified private IP address does not fall within the CIDR block of the specified vSwitch.
400InvalidPrivateIpAddress.MalformedSpecified private IP address is invalid.-
400InvalidPrivateIpAddress.DuplicatedSpecified private IP address is duplicated.-
400QuotaExceeded.PrivateIpAddressDon't have enough private IPs in this switch.-
400QuotaExceededLiving instances quota exceeded in this VPC.The maximum number of the living instance is exceeded.
400IncorrectVSwitchStatusThe current status of virtual switch does not support this operation.The specified vSwitch is in the Pending state and cannot be deleted.
400InvalidParameter.MismatchSpecified virtual switch is not in the specified zone.The specified vSwitch does not exist in the specified zone.
400ResourceNotAvailableResource you requested is not available in this region or zone.VPC is not supported by the specified region or zone.
400MissingParameterThe input parameter "VSwitchId" that is mandatory for processing this request is not supplied.-
400InvalidDiskCategory.MismatchThe specified disk categories' combination is not supported.-
400InvalidIoOptimizedValue.ValueNotSupportedIoOptimized value not supported.The specified IoOptimized value is not supported.
400MissingParamterThe specified parameter "Period" is not null.-
400InvalidPeriodThe specified period is not valid.The specified period is invalid.
400InvalidDataDiskCategory.ValueNotSupportedThe specified parameter " DataDisk.n.Category " is not valid.-
400InstanceDiskCategoryLimitExceedThe specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.The specified DataDisk.N.Size parameter is invalid or the snapshot size exceeds the maximum capacity allowed for the specified disk category.
400InvalidParameterThe specified vm bandwidth is not valid.The specified bandwidth value of the instance is invalid.
400InvalidSystemDiskCategory.ValueNotSupportedThe specified parameter SystemDisk.Category is not valid.-
400InvalidParameter.BandwidthThe specified parameter Bandwidth is not valid.The specified bandwidth value is invalid.
400InvalidIPAddress.AlreadyUsedThe specified IPAddress is already used by other resource.The specified IP address is being used by another resource.
400InvalidUserData.SizeExceededThe specified parameter "UserData" exceeds the size.-
400InvalidUserData.NotSupportedThe specified parameter "UserData" only support the vpc and IoOptimized Instance.-
400InstanceDiskNumber.LimitExceedThe total number of specified disk in an instance exceeds.The number of disks on an instance exceeds the upper limit.
400Account.ArrearageYour account has an outstanding payment.Your account has overdue payments.
400InvalidDiskCategory.ValueNotSupportedThe specified parameter "DiskCategory" is not valid.-
400InvalidAutoRenewPeriod.ValueNotSupportedThe specified autoRenewPeriod is not valid.The specified AutoRenewPeriod parameter is invalid.
400QuotaExceed.AfterpayInstanceThe maximum number of Pay-As-You-Go instances is exceeded.-
400InvalidSpotStrategyThe specified SpotStrategy is not valid.The specified SpotStrategy parameter is invalid.
400InvalidSpotParam.EmptyZoneIDThe specified ZoneId is empty when SpotStrategy is set.The ZoneId parameter is not specified while the SpotStrategy parameter is specified.
400InvalidSpotPriceLimitThe specified SpotPriceLimitis not valid.The specified SpotPriceLimit parameter is invalid.
400InvalidSpotDurationThe specified SpotDuration is not valid.The specified SpotDuration parameter is invalid.
400InvalidSpotAuthorizedThe specified Spot param is unauthorized.You are not authorized to set the SpotDuration parameter.
400InvalidSpotPrepaidThe specified Spot type is not support PrePay Instance.Preemptible instances do not support the subscription billing method.
400InvalidSpotAliUidThe specified UID is not authorized to use SPOT instance.You are not authorized to create preemptible instances.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
400InvalidParameter.Bandwidth%sThe specified bandwidth value is invalid.
400InvalidDataDiskCategory.ValueNotSupported%s-
400InvalidSystemDiskCategory.ValueNotSupported%sThe specified system disk category is invalid.
400InvalidParameter.Conflict%sThe specified parameter is invalid. Check whether parameter conflicts exist. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidInternetChargeType.ValueNotSupported%sThe specified InternetChargeType parameter is invalid.
400InvalidInstanceType.ValueNotSupported%sThe operation is not supported by the specified instance type.
400RegionUnauthorized%s-
400Zone.NotOnSale%sThe requested resources are unavailable in the specified zone. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidSystemDiskSize.ValueNotSupported%sThe specified system disk size is invalid.
400InvalidDataDiskSize.ValueNotSupported%s-
400InvalidInstanceType.ValueNotSupportedThe specified parameter "KeyPairName" only support IoOptimized Instance.-
400OperationDeniedThe specified InstanceType or Zone is not available or not authorized.The specified instance type or zone is unavailable or you are not authorized to use the specified instance type or access the specified zone.
400InvalidParameter.EncryptedIllegal%sThe specified parameter is invalid. Check whether your encryption operation is supported. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidParameter.EncryptedNotSupported%sThe specified parameter is invalid and your encryption operation is not supported. %s is a variable. An error message is dynamically returned based on call conditions.
400EncryptedOption.Conflict%sThe specified parameter is invalid and your encryption operation is not supported. %s is a variable. An error message is dynamically returned based on call conditions.
400InvalidSpotPriceLimit.LowerThanPublicPriceThe specified parameter "soptPriceLimit" can't be lower than current public price.-
400InvalidHpcClusterId.UnnecessaryThe specified HpcClusterId is unnecessary.The HpcClusterId parameter is specified.
400InvalidVSwitchId.NecessaryThe VSwitchId is necessary.The VSwitchId parameter is required.
400InvalidHpcClusterId.NecessaryThe HpcClusterId is necessary.The HpcClusterId parameter is required.
400InvalidHpcClusterId.NotFoundThe specified HpcClusterId is not found.The specified HpcClusterId parameter does not exist.
400InvalidHpcClusterId.CreatingThe specified HpcClusterId is creating.The specified HPC cluster is being created.
400InvalidPeriodUnit.ValueNotSupportedThe specified parameter PeriodUnit is not valid.The specified PeriodUnit parameter is invalid.
400IncorrectImageStatusEncrypted snapshots do not support this operation.Encrypted snapshots do not support the operation.
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
400InvalidSecurityGroup.NotInDefaultVpc%sThe security group is not in the default VPC. Check whether the specified SecurityGroupId parameter is correct.
400VpcNotFoundVpc is not found according to the specified VSwitch or the vpc does not belong to you.No VPC is found based on the specified vSwitch or the corresponding VPC does not belong to you.
400InvalidSpotInterruptionBehavior%sThe specified SpotInterruptionBehavior parameter is not supported.
400OperationDenied.IllegalPaymentPolicyThe current payment policy is illegal, please connect your service provider to authenticate relative agreement.The current payment policy is invalid. Contact your service provider to validate agreements relevant to the payment policy.
400InvalidDeploymentOnHost%s-
400InvalidInstanceChargeType.NotSupportThe Dedicated host not support the specified Instance charge type.This dedicated host does not support instances that use the specified billing method.
400InvalidNetworkType.NotSupportedThe classic networkType not support create ECS on dedicatedHost.-
400InvalidDedicatedHostId.NotFoundThe specified DedicatedHostId does not exist.-
400InvalidDedicatedHostStatus.NotSupportOperation denied due to dedicated host status.-
400IncorrectDedicatedHostStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
400ChargeTypeViolation.PostPaidDedicatedHostPrepaid instance onto postpaid dedicated host is not allowed.-
400InvalidPeriod.ExceededDedicatedHostInstance expired date can't exceed dedicated host expired date.-
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorize.You are not authorized to use the instance type.
400DedicatedHostType.UnmatchedThe specified DedicatedHostType doesn?t match the instance type.-
400NoAvaliableDedicatedHostThere's no enough resource on the specified dedicated host.-
400NoAvaliableDedicatedHostNo available dedicated host or not enough resource on dedicated host.-
400InvalidParameter.AffinityThe specified Affinity is invalid.-
400InvalidParameter.TenancyThe specified Tenancy is invalid.-
400InvalidParam.TenancyThe specified Tenancy is invalid.The specified Tenancy parameter is invalid.
400InvalidParameter.CreditSpecificationThe specified CreditSpecification is not supported in this region.The specified credit specification is not supported in this region.
400IncorrectImageStatusThe specified image is an Alibaba Cloud Marketplace image. The sale of this image has ended. For more information, contact the image service provider.The specified image is an Alibaba Cloud Marketplace image that is no longer sold. For more information about the image, contact the image provider.
400InvalidInstanceType.NotSupportedThe specified instanceType is not supported by the deployment set.The current deployment set does not support the specified instance type. Try another instance type.
400InvalidInstanceType.NotSupportedThe specified instanceType is not supported by the image architecture.-
400InvalidVpcZone.NotSupportedZone of the specified VSwitch is not available for creating, please try in other zones.The default vSwitch cannot be created in the specified zone. Try another zone.
400IncorrectDefaultVpcStatusThe status of the default VPC is invalid.The state of the default VPC is invalid.
400InvalidParameter.EncryptedIllegalThe specified parameter Encrypted must be true when kmsKeyId is not empty.The encryption feature is not enabled after a Key Management Service (KMS) key ID is specified.
400IoOptimized.NotSupportedThe specified instance must be IoOptimized instance when kmsKeyId is not empty.The specified instance must be an I/O optimized one when the KMSKeyId parameter is specified.
400InvalidClientToken.ValueNotSupportedThe ClientToken provided is invalid.The specified ClientToken parameter is invalid.
400OperationDeniedThe current user does not support this operation.Your account does not support this operation.
400InvalidCapacityReservationId.NotFoundThe specified CapacityReservationId does not exist.-
400LackResourceThere's no enough resource on the specified capacity reservation.-
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
400InvalidParameter.ArnsThe specified Arns is not valid.-
400InvalidOperation.NotSupportEnterpriseGroupThe specified instance type doesn't support enterprise level security group.-
400NoAvaliableDedicatedHostA dedicated host with sufficient available resources cannot be found.-
400IncorrectVSwitchStatusThe current status of vSwitch does not support this operation.-
400InvalidOperation.MultiGroupTypeThe specified instance can't join different types of security group.-
400InvalidAccountStatus.PayAmountLimitExceededYour account is being restricted, because you have no default payment method or you are not authorized.-
400InvalidPerformanceLevel.MalformedThe specified parameter DataDisk.n.PerformanceLevel is not valid.-
400InvalidSecurityGroup.NetworkType%s-
400QuotaExceeded.PrepayDataDiskCapacityThe quota of prepay data disk capacity exceeds.-
400InvalidCustomInstanceType.NotSupportedThe specified custom instance type is invalid.-
400InvalidParameter%sThe specified parameter is invalid.
400QuotaExceeded.PrivateIpAddressThere is not enough private ip in the specified VSwitch.-
400InvalidOperation.EniCountExceededThe maximum number of eni in a enterprise security group is exceeded.-
400AccountForbidden.ProductCreationLimitedThe commodity must be officially operated by Aliyun and in pay-as-you-go billing method.-
400UnexpectedImageFamily.ImageIdSuppliedThe input parameter ImageFamily must be null when image id is set.The ImageFamily parameter must be left empty if an image ID is specified.
400InvalidEncrypted.NotMatchEncryptAlgorithmThe specified parameter Encrypted must be true when EncryptAlgorithm is not empty.-
400InvalidEncrypted.NotMatchKmsKeyIdThe specified parameter Encrypted must be true when KmsKeyId is not empty.-
400InvalidEncrypted.NotMatchSnapshotThe specified parameter Encrypted is different from the Encrypted of the snapshot.-
400InvalidEncryptAlgorithm.NotMatchSnapshotThe specified parameter EncryptAlgorithm is different from the encrypt algorithm of the snapshot.-
400InvalidKmsKeyId.NotMatchSnapshotThe specified parameter KmsKeyId is different from the KmsKeyId of the snapshot.-
400InvalidEncryptAlgorithmThe specified parameter EncryptAlgorithm is not valid.-
400InvalidHttpEndpoint.NotSupportedThe specified HttpEndpoint not supported, you can use enabled(default) or disabled.The specified HttpEndpoint parameter is invalid. The valid values of this parameter are enabled and disabled. The default value is enabled.
400InvalidHttpTokens.NotSupportedThe specified HttpTokens not supported, you can use optional(default) or required.The specified HttpTokens parameter is invalid. The valid values of this parameter are optional and required. The default value is optional.
400InvalidHttpPutResponseHopLimit.NotSupportedThe specified HttpPutResponseHopLimit not supported, more than 1 and less than 64 is reasonable.The specified HttpPutResponseHopLimit parameter is invalid. The valid values of this parameter are 1 to 64.
400InvalidPrivateIpAddress.MalformedSpecified private IP address is malformed.The specified private IP address is invalid.
400InvalidOperation.VpcHasEnabledAdvancedNetworkFeatureThe specified vpc has enabled advanced network feature.Advanced features are enabled for the specified VPC. You cannot create low-specification instances in the VPC.
400InvalidChargeType.CapacityReservationNotSupported%s-
400InvalidPerformanceLevel.ValueNotSupportedThe current ZoneId or InstanceType does not support PL0 of cloud_essd.-
400InvalidKMSKeyId.NotSymmetricThe specified parameter KmsKeyId must be symmetric.-
400InvalidDedicatedHostClusterId.NotFoundThe specified DedicatedHostClusterId does not exist.-
400InvalidDedicatedHostClusterId.InValidThe specified Dedicated Host Cluster is invalid.-
400InvalidOperation.UserNotSupportedReseller user do not support purchase at the moment.-
400InvalidDeploymentSetId.NotFoundThe parameter DeploymentSetId is invalid.-
400MissingParameter.PrivatePoolOptionsIdThe specified PrivatePoolOptions.Id should not be null.The PrivatePoolOptions.Id parameter is required.
400Invalid.PrivatePoolOptionsIdThe specified PrivatePoolOptions.Id is invalid.The specified PrivatePoolOptions.Id parameter is invalid.
400Invalid.PrivatePoolOptionsIdThe parameter PrivatePoolOptions.Id should be null when PrivatePoolOptions.MatchCriteria is not Target.The PrivatePoolOptions.Id parameter is specified when the PrivatePoolOptions.MatchCriteria parameter is set to a value other than Target.
400DedicatedHostNotSupportedDedicatedHost is not supported for PrivatePool.The private pool does not support dedicated hosts.
400SpotNotSupportedSpot is not supported for PrivatePool.The private pool does not support preemptible instances.
400ClassicNetworkNotSupportedClassic network is not supported for PrivatePool.The private pool does not support instances in the classic network.
400Invalid.InstanceIdInstance does not exist.The specified instance does not exist.
400Invalid.PrivatePoolOptions.MatchCriteriaTarget mode does not support this operation.The operation is not supported while the PrivatePoolOptions.MatchCriteria parameter is set to Target.
400MissingParameter.PrivatePoolOptions.IdThe specified PrivatePoolOptions.Id should not be null.The PrivatePoolOptions.Id parameter is required.
400Invalid.PrivatePoolOptions.IdThe PrivatePool does not exist.The private pool does not exist.
400Invalid.InstanceTypeThe InstanceType does not match the PrivatePool.The instance type and the private pool do not match.
400Invalid.InstanceChargeTypeThe InstanceChargeType does not match the PrivatePool.The instance billing method and the private pool do not match.
400Invalid.ZoneIdThe ZoneId does not match the PrivatePool.The zone and the private pool do not match.
400Invalid.PrivatePoolOptions.NoStockThe PrivatePool has been used up.-
400Invalid.PrivatePoolOptions.MatchCriteriaThe PrivatePoolOptions.MatchCriteria does not match the PrivatePool.The specified PrivatePoolOptions.MatchCriteria parameter does not match the private pool.
400InvalidPlatform.ValueNotSupportedThe Platform does not match the PrivatePool.The specified Platform parameter does not match the private pool.
400Invalid.PrivatePoolOptions.statusThe PrivatePool is expired or inactive.-
400Invalid.PrivatePoolOptions.statusThe PrivatePool status is not valid.-
400Invalid.PrivatePoolOptions.statusThe Instance should be created within 48 hours once the PrivatePool is started.-
400InvalidAliUidThe PrivatePool does not belong to the user of the Instance.The specified private pool does not belong to the user who attempted to create the instance.
400Invalid.InstanceIdThe Instance dose not attached to a PrivatePool.The instance and the private pool do not match.
400HibernationConfigured.InstanceTypeNotSupportThe specified instance type is not support.-
400HibernationConfigured.ImageNotEncryptedThe hibernation configured instance only support encrypted image.-
400HibernationConfigured.MemorySizeTooBigThe hibernation configured instance memory size is too big.-
400InvalidSystemDiskSize.LessThanMemSizeThe specified parameter SystemDisk.Size is less than the memory size.-
400InvalidCloudBoxZone.OperationNotSupportedThe cloud box zone does not support creating prepaid or encrypted resources.-
400InvalidParameter.KMSKeyId.CMKUnauthorizedThis operation for kmsKeyId is forbidden by KMS. If you need further assistance, you can contact the KMS Technical Support.-
400InvalidInternetMaxBandwidthOut.MalformedThe specified parameter InternetMaxBandwidthOut is not valid.The specified InternetMaxBandwidthOut parameter is invalid.
400InvalidInternetMaxBandwidthIn.MalformedThe specified parameter InternetMaxBandwidthIn is not valid.The specified InternetMaxBandwidthIn parameter is invalid.
400InvalidParameter.CloudboxNotSupported%s-
400NotSupportSnapshotEncrypted.ShareImage Shared snapshot creating encrypted disks with native snapshot encrypt is not supported.-
400QuotaExceed.DiskCapacityThe used capacity of disk type has exceeded the quota in the zone, %s.The capacity of disks that belong to the specified disk category exceeds the quota limit for the zone.
400InvalidPeriod.ExceededDedicatedHostInstance expired date can not exceed dedicated host expired date.The expiration date of the instance is later than that of the dedicated host.
400InvalidParameter.DataEncryptedKeyCreateFailedCreate kms data encrypted key fail. If you need further assistance, you can contact the KMS Technical Support.-
400InvalidDiskCategory.NotSupportedThe specified disk category is not supported.The specified disk category does not support this operation.
400InvalidDestinationZone.DeploymentSetMismatchError happened, %s.-
400NoPermission.PriceThe operation requires price permission. Please either apply for permission from your main account, or set the parameter AutoPay as true.-
400InvalidParameter.DedicatedRegionNotSupportedThe specified action is rejected because the specified ECS instance in the dedicated region does not support public IP.Parameter error codes not supported in the dedicated region
400InvalidParameter.KmsNotEnabledFailed to perform this operation because KMS is not activated.You need to activate KMS key management service.
400InvalidParameter.Encrypted.KmsNotEnableFailed to perform this operation because KMS is not activated.You need to activate KMS key escrow service.
400InvalidParam.EncryptedMismatchCreating encrypted disks with shared encrypted image requires replacing encryption keys.You must change the encryption key to create a cloud disk after sharing an encrypted image.
401InvalidRamRole.NotEcsRoleThe specified ram role is not authorized for ecs, please check your role policy.The specified RAM role is not authorized to use ECS. Check your role policies.
403InvalidDiskCategory.NotSupportedThe specified disk category is not support the specified instance type.The specified disk category does not support the instance type.
403ImageNotSubscribedThe specified image has not be subscribed.You have not subscribed to the specified image in Alibaba Cloud Marketplace.
403OperationDeniedThe specified Image is disabled or is deleted.The specified image is disabled or deleted.
403InvalidSystemDiskCategory.ValueUnauthorizedThe disk category is not authorized.You are not authorized to use the specified disk category.
403InvalidSnapshotId.NotReadyThe specified snapshot has not completed yet.The specified snapshot is being created.
403OperationDeniedThe specified snapshot is not allowed to create disk.The specified snapshot cannot be used to create disks.
403InstanceDiskCategoryLimitExceedThe total size of specified disk category in an instance exceeds.The total size of disks of the specified category exceeds the maximum capacity allowed for an instance.
403InvalidDevice.InUseThe specified device has been occupied.The specified device has been occupied.
403ImageRemovedInMarketThe specified market image is not available, Or the specified user defined image includes product code because it is based on an image subscribed from marketplace, and that image in marketplace includeing exact the same product code has been removed.The specified Alibaba Cloud Marketplace image is unavailable, or the specified custom image contains the product code of the Alibaba Cloud Marketplace image from which the custom image is derived and the Alibaba Cloud Marketplace image was removed from Alibaba Cloud Marketplace.
403OperationDeniedThe creation of Instance to the specified Zone is not allowed.Instances cannot be created in the specified zone.
403CategoryNotSupportedThe specified zone does not offer the specified disk category.The specified disk category is unavailable in the specified zone.
403OperationDeniedThe specified Zone or cluster does not offer the specified disk category or the speicified zone and cluster do not match.The specified disk category is unavailable in the specified zone or cluster, or the specified zone and cluster do not correspond to each other.
403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.The requested resources are insufficient.
403QuotaExceed.PortableCloudDiskThe quota of portable cloud disk exceeds.The maximum number of removable disks has been reached.
403OperationDeniedSales of this resource are temporarily suspended in the specified region; please try again later.The requested resource is unavailable in the specified region. Try again later.
403SecurityGroupInstanceLimitExceedThe maximum number of instances in a security group is exceeded.-
403NodeControllerUnavailableThe Node Controller is temporarily unavailable.The node controller is unavailable.
403RegionUnauthorizedThere is no authority to create instance in the specified region.You are not authorized to create instances in the specified region.
403CategoryNotSupportedThe specified Zone or cluster does not offer the specified disk category.The specified disk category is unavailable in the specified zone or cluster.
403InvalidSnapshotId.NotDataDiskSnapshotThe specified snapshot is system disk snapshot.The specified snapshot is a system disk snapshot.
403CategoryNotSupportedThe specified cluster does not offer the specified disk category.The specified disk category is unavailable in the specified cluster.
403DeleteWithInstance.ConflictThe specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute.The specified disk is not removable and cannot be released along with the instance.
403InstanceDiskNumLimitExceedThe number of specified disk in an instance exceeds.The number of specified disks exceeds the upper limit for an instance.
403IoOptimized.NotSupportedThe specified image is not support IoOptimized Instance.The specified image does not support I/O optimized instances.
403ImageNotSupportInstanceTypeThe specified image don't support the InstanceType instance.The specified image does not support the selected instance type.
403InvalidDiskSize.TooSmallSpecified disk size is less than the size of snapshot.The specified disk size is smaller than the snapshot size.
403OperationDeniedThe type of the disk does not support the operation.The disk category does not support the specified operation.
403InvalidDiskCategory.MismatchThe specified disk categories combination is not supported.The combination of specified disk categories is not supported.
403IoOptimized.NotSupportedVpc is not support IoOptimized instance.The VPC does not support I/O optimized instances.
403OperationDeniedThe resource is out of usage.The instance is not in the Running state. Start the instance or check whether the specified operation is valid.
403QuotaExceed.BuyImageThe specified image is from the image market, You have not bought it or your quota has been exceeded.-
403InvalidVSwitchId.NotFoundThe VSwitchId provided does not exist in our records.The specified vSwitch ID does not exist.
403InvalidParameter.ResourceOwnerAccountResourceOwnerAccount is Invalid.The specified ResourceOwnerAccount parameter is invalid.
403InvalidUserData.ForbiddenUser not authorized to input the parameter "UserData", please apply for permission "UserData".-
403Zone.NotOpenThe specified zone is not granted to you to buy resources yet.You are not authorized to purchase resources in the specified zone.
403Zone.NotOnSaleThe specified zone is not available for purchase.The requested resources are unavailable in the specified zone. Try a different instance type or select a different region or zone.
403InvalidClusterId.NotFoundThe specified clusterId does not exist.The specified ClusterId parameter does not exist.
403InvalidResourceType.NotSupported%s-
403InvalidInstanceType.ZoneNotSupportedThe specified zone does not support this instancetype.The specified instance type is not supported in the specified zone.
403InvalidPayMethodThe specified pay method is not valid.The specified payment method is invalid.
403OperationDenied.ImageNotValidThe specified Image is disabled or is deleted.The specified image does not exist.
403InvalidUserData.Base64FormatInvalidThe specified UserData is not valid.The specified user data is invalid.
403InstanceType.Offline%sThe operation is not supported while the instance type is retired or while resources of the instance type are insufficient.
403DependencyViolation.WindowsInstanceThe instance creating is window, cannot use ssh key pair to login.The specified instance is a Windows instance and does not support logons using SSH key pairs.
403RealNameAuthenticationErrorYour account has not passed the real-name authentication yet.You have not completed real-name verification. Complete real-name verification and try again.
403InvalidNetworkType.MismatchRamRoleRam role cannot be applied to instances of Classic network type.Instance RAM roles can be used only for instances of the VPC type, not for instances of the classic network type.
403InvalidUser.PassRoleForbiddenThe RAM user does not have the privilege to pass a RAM role.The RAM user is not authorized to pass a RAM role.
403InvalidImage.NotSupportedThe specified image does not support vSGX instance.-
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403IncorrectVpcStatusCurrent VPC status does not support this operation.The VPC is in a state that does not support the current operation.
403InvalidParameter.NotMatch%sA specified parameter is invalid. Check whether parameter conflicts exist.
403OperationDenied.InvalidNetworkType%sThe network type does not support this operation.
403InvalidSpotInterruptionBehavior.ClassicNetworkNotSupportThe specified SpotInterruptionBehavior does not support Classic network Instance.-
403InvalidSpotInterruptionBehavior.LocalDiskNotSupportThe specified SpotInterruptionBehavior does not support local disk instance.-
403OperationDenied.ImageNotValid%sThe current image does not support this operation.
403QuotaExceed.PostPaidDiskLiving postPaid disks quota exceeded.-
403QuotaExceed.DeploymentSetInstanceQuotaFullInstance quota in one deployment set exceeded.-
403InvalidVSwitch.DefaultVSwitchNotSupportThe specified zone in vpc can't support create default vSwitch.-
403OperationDenied.ImageNotValidThe specified image is not published in the region.The image is unavailable in the current region.
403OperationDenied.ImageNotValidThe specified image is not authorized.You are not authorized to use this image.
403OperationDenied.ImageNotValidThe specified image is not found in marketplace.The specified image is not present in Alibaba Cloud Marketplace.
403OperationDenied.LocalDiskUnsupportedThe configuration change is not allowed when the specified instance has local disks mounted.Instance types cannot be changed for instances that have local disks attached.
403OperationDenied.InconsistentNetworkThe specified security group and vswitch are not in the same vpc.The specified security group and vSwitch do not belong to the same VPC.
403OperationDeniedIf the network segment of the vswitch is the same as that of its VPC. Therefore, the VPC cannot create other vswitchs across the region.The VPC and vSwitch have the same CIDR block and no additional vSwitches can be created in zones of the VPC.
403DefaultVswitch.ExistedThe default vswitch for VPC already exists.-
403InvalidChargeType.ValueNotSupportedDeletion protection is only valid for postPaid instance, not for prePaid or spot instance.Release protection can be enabled only for pay-as-you-go instances.
403IncorrectInstanceStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
403CategoryViolationThe specified instance does not support this operation because of its disk category.The configurations of instances that have local disks attached cannot be upgraded or downgraded.
403ResourcesNotInSameZoneThe specified instance and dedicated host are not in the same zone.-
403InvalidRegion.NotSupportThe specified region does not support byok.The bring your own key (BYOK) feature is not supported in the region.
403UserNotInTheWhiteListThe user is not in byok white list.You are not authorized to use the bring your own key (BYOK) feature. Try again when you are authorized.
403InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK.
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.ECS is not authorized to access your KMS resources.
403SecurityRisk.3DVerificationWe have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email.-
403InvalidDisk.SystemDiskSizeThe specified SystemDiskSize beyond the permitted range.The specified system disk size exceeds the maximum allowed value.
403InsufficientBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403OperationDeniedThe user profile is not complete; try complete your basic info in account management page.-
403Mayi.InternalErrorThe request processing has failed due to some unknown error.-
403InvalidNetworkTypeThe network type is not support in this region.-
403InvalidAccountStatusYour account status is invalid, please contact customer service.-
403UserNotInTheWhiteListThe user is not in Arns white list.-
403QuotaExceeded.PrivateIpAddress%s-
403InvalidVSwitchId.IpInvalid%sThe specified private IP address is invalid.
403OperationDenied.PerformanceLevelNotMatchThe specified DataDisk.n.PerformanceLevel and DataDisk.n.Size do not match.-
403InvalidStorageSetName.MalformedSpecified parameter StorageSetName is not valid.-
403InvalidDescription.MalformedSpecified parameter Description is not valid.-
403InvalidMaxPartitionNumber.MalformedSpecified parameter MaxPartitionNumber is not valid.-
403InvalidParameter.StorageSetPartitionNumberSpecified parameter StorageSetPartitionNumber is not valid.-
403InvalidParameter.StorageSetIdSpecified parameter StorageSetId is not valid.-
403InvalidParameter.StorageSetZoneIdSpecified parameter StorageSetZoneId is not valid.-
403InvalidParameter.StorageSetZoneIdSpecified parameter ZoneNo does not match with StorageSet info.-
403QuotaExceed.Tags%sThe number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
403OperationDenied.RegionIdNotSupportedRegion not support spot duration instance.-
403OperationDenied.FlavorNotSupportedFlavor not support spot duration instance.-
403OperationDenied.TimestampNotSupportedTimestamp not support spot duration instance.-
403OperationDenied.PrepayNotAvailablePrepay instance is not available now.-
403OperationDenied.PaygNotAvailablePay-as-you-go instance is not available now.-
403EnterpriseGroupLimited.MutliGroupTypeThe specified instance can not join multi SecurityGroup types.The specified instance cannot belong to both a basic and an advanced security group. You can call the DescribeSecurityGroups operation to query the type of security groups.
403EnterpriseGroupLimited.InstanceTypeThe specified instance type does not support Enterprise SecurityGroup.-
403InternalError.AllocateUnderlayIpAllocate underlay ip for the instance error.Failed to assign the Underlay IP address to the instance.
403OperationDenied.BidOwnResourceBid user can not own resource.-
403OperationDenied.CloudSSDNotSupportedThe specified available zone does not offer the cloud_ssd disk, use cloud_essd instead.-
403InvalidVPCStatus.NotWorkingThe specified VPC subnet status is not working.-
403QuotaExceed.ElasticQuotaNo additional quota is available for the specified ECS instance type.The maximum number of instances of the specified instance type in the region has been reached. Reduce the quantity of instances that you want to purchase or try another region or instance type. Alternatively, you can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type.The maximum number of instances of the specified instance type in the region has been reached. Reduce the quantity of instances that you want to purchase or try another region or instance type. Alternatively, you can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.The maximum number of vCPUs for all instance types has been reached. You can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type, or the number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.The maximum number of instances of the specified instance type in the region has been reached, or the maximum number of vCPUs for all instance types has been reached. You can go to the ECS console or Quota Center to request a quota increase.
403QuotaExceeded.PostpaidDataDiskCapacityThe quota of postpaid data disk capacity exceeds.The used capacity of the pay-as-you-go disk reaches the quota limit.
403InvalidImageFamily.MissingAvailableImageThere is no available image related to the specified image family.-
403InvalidRegionId.NotSupportEncryptAlgorithmThe current region does not support creating encrypted disks with EncryptAlgorithm.-
403InvalidOperation.ResourceManagedByCloudProduct%sYou cannot modify security groups managed by cloud services.
403InvalidDiskSize.TooSmallSpecified disk size is too small when choosing PL0 of cloud_essd.-
403DeleteWithInstance.ConflictThe specified image is from the image market, you cannot set DeleteWithInstance attribute to false.-
403Forbidden.OnlySupportEnterpriseGroup%s-
403HibernationConfigured.InstanceOperationForbiddenThe operation is not permitted due to limit of the hibernation configured instance.The operation cannot be performed due to the limitations of instances for which the instance hibernation feature is enabled.
403InstanceDiskLimitExceededThe amount of the disk on instance reach its limits.-
403InvalidInstanceType.NotSupportDiskCategoryThe instanceType of the specified instance does not support this disk category.The instance type does not support the current disk category. Try another instance type. For information about the disk categories supported by instance types, see the instance family documentation.
403NotSupportSnapshotEncrypted.DiskCategoryThe specified disk category does not support creating encrypted system disks or creating encrypted data disks from snapshots. Check the DiskCategory or Encrypted parameter, or check your account for default encryption settings.This disk type does not support creating encrypted system disks or creating encrypted data disks in snapshot mode. Please check the disk type and encryption parameters you entered, or check whether you have configured the default encryption configuration for account cloud disks.
403InvalidEncrypted.DefaultEncryptionUnsupportedThe specified parameter Encrypted must be true when default encryption is enabled.After the cloud disk is encrypted by default, the newly purchased cloud disk must be an encrypted cloud disk.
403InvalidOperation.PublicIpAddressNoStockThe public IP address for the specified Region or ChargeType of the instance is out of stock. Please try another Region or ChargeType.Under the conditions of the specified region or payment type, the public IP address inventory of the instance is insufficient. Please try another region or payment type.
403QuotaExceed.ElasticQuota%s .If your ECS usage exceeds the quota limit, go to the Alibaba Cloud console to apply for a quota increase.
404InvalidStorageClusterId.NotExistThe specified StorageClusterId does not exist in current region.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404IoOptimized.NotSupportedThe specified instancetype is not support IoOptimized instance.-
404InvalidZoneId.NotFoundThe ZoneId provided does not exist in our records.The specified zone ID does not exist.
404InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.The specified security group does not exist in this account. Check whether the security group ID is correct.
404InvalidDataDiskSnapshotId.NotFoundThe specified parameter "DataDisk.n.SnapshotId" is not valid.-
404InvalidClusterId.NotFoundThe ClusterId provided does not exist in our records.The specified ClusterId parameter does not exist.
404InvalidVSwitchId.NotFoundSpecified virtual switch does not exist.The specified vSwitch ID does not exist.
404InvalidImageId.NotFoundThe specified ImageId does not exist.The specified image does not exist in this account. Check whether the image ID is correct.
404OperationDeniedAnother Instance has been creating.-
404InvalidInstanceChargeType.NotFoundThe InstanceChargeType does not exist in our records.The specified instance billing method does not exist.
404DependencyViolation.IoOptimizedThe specified instancetype must be IoOptimized instance.The specified instance type must be I/O optimized. Check your instance type and try again.
404PaymentMethodNotFoundNo payment method has been registered on the account.You have not configured a payment method for your account.
404HOSTNAME_ILLEGALThe specified parameter Hostname is not valid.-
404InvalidSystemDiskSize.LessThanImageSizeThe specified parameter SystemDisk.Size is less than the image size.The specified system disk size is smaller than the image size.
404InvalidSystemDiskSize.LessThanMinSizeThe specified parameter SystemDisk.Size is less than the min size.The specified system disk size is smaller than the minimum allowable size.
404InvalidSystemDiskSize.MoreThanMaxSizeThe specified SystemDisk.Size parameter exceeds the maximum size.The maximum size of the system disk is exceeded.
404InvalidDataDiskSnapshotId.NotFoundThe specified parameter DataDisk.n.SnapshotId is not valid.The specified data disk snapshot ID is invalid.
404InvalidSystemDiskSizeThe specified parameter SystemDisk.Size is invalid.The specified SystemDisk.Size parameter is invalid.
404InvalidZoneId.NotFoundThe specified ZoneId does not exist.The specified zone ID does not exist.
404InvalidKeyPairName.NotFoundThe specified parameter KeyPairName does not exist in our records.The specified key pair does not exist.
404InvalidRamRole.NotFoundThe specified RAMRoleName does not exist.The specified RamRoleName parameter does not exist.
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The specified resource group does not exist.
404InvalidMarketImage.NotFoundThe specified marketplace image does not exist, please change the imageId and try again.The specified Alibaba Cloud Marketplace image does not exist. Modify the ImageId parameter and try again.
404DeploymentSet.NotFoundThe specified deployment set does not exist.The specified deployment set does not exist.
404InvalidParameter.KMSKeyId.NotFoundThe specified KMSKeyId does not exist.The specified KMSKeyId parameter does not exist.
404InvalidSecurityGroupId.NotFound%sThe specified security group ID does not exist.
404InvalidDiskIds.NotPortableThe specified DiskId is not portable.The specified disk is not removable.
409OperationConflictRequest was denied due to conflict with a previous request,please try again later.-
429Throttling.ResourceThe request throttle by resource operation.-
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.
500InternalError%sAn internal error has occurred.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred. Try again later.
500InvalidImage.OSTypeThe image OSType does not support this instance type.-

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

Change history

Change timeSummary of changesOperation
2024-03-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 401
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500
2024-01-30The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 400
    delete Error Codes: 401
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500
2024-01-15The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 400
    delete Error Codes: 401
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500
2023-10-10The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 401
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500
2023-06-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 401
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500
2023-05-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 400
    delete Error Codes: 401
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500
2023-03-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 401
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 409
    delete Error Codes: 429
    delete Error Codes: 500