All Products
Search
Document Center

:CreateInstance

更新时间:Jan 08, 2024

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

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 that are 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, the maximum number of instances of the specified instance type that can be created in the specified region or the maximum number of vCPUs for all instance types in a zone is reached. You can go to the ECS console or Quota Center to apply for 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 can use only Windows Server Semi-Annual Channel images.
    • If you want to create instances with 4 GiB or more of memory, you cannot use a 32-bit operating system image.
  • Network type:
    • Each instance that resides in a virtual private cloud (VPC) must be connected to only one 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 from November 27, 2020, the maximum bandwidth that is available for creating ECS instances or for changing ECS instance configurations is subject to the throttling policies for your account. To increase the maximum bandwidth value, submit a ticket. The throttling policy imposes the following constraints: In a 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 manually assign public IP addresses to instances.
    • 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, which 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, which 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, call the CreateSecurityGroup operation to create a security group in the region.
    • 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 Limits.
    • 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 their security groups. 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 capacity of the system disk must be at least 20 GiB and greater than or equal to the image size. For more 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 its category. For more information, see the description of DataDisk.N.Size.
    • You can attach up to 16 data disks an instance. The system allocates the mount points of data disks in alphabetical order from /dev/xvdb to /dev/xvdz.

      Note If the QuotaExceed.DiskCapacity error is returned when you call this operation, the maximum capacity of disks of the specified disk category that can be created in the specified zone is reached. You can go to the ECS console or Quota Center to request a quota increase.

  • User data: If the instance type supports user data, you can use UserData 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 because the system does not encrypt UserData values when API requests are sent. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64 and then decode and decrypt the information in the same manner within the instance.
  • Others: When you call API operations by using Alibaba Cloud CLI or SDKs, delete periods (.) from specific 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes CreateInstance

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

RegionId String Yes cn-hangzhou

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

ImageId String No ubuntu_18_04_64_20G_alibase_20190624.vhd

The ID of the image file that you want to use to create the instance. If you want 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 most recent available custom image from the specified image family.

ImageFamily String No hangzhou-daily-update

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

  • ImageFamily must be empty if ImageId is specified.
  • ImageFamily can be specified if ImageId is not specified.
InstanceType String Yes ecs.g6.large

The instance type.

SecurityGroupId String No sg-bp15ed6xe1yxeycg****

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

InstanceName String No k8s-node-[1,4]-alibabacloud

The name of the instance. The name must be 2 to 128 characters in length, The name must start with a letter but cannot start with http:// or https://. The name 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.

InternetChargeType String No PayByTraffic

The billing method for network usage. Valid values:

  • PayByBandwidth
  • PayByTraffic (default)
Note If the pay-by-traffic billing method is used for network usage, the maximum inbound and outbound bandwidth values are used as upper limits of bandwidths instead of the guaranteed performance specifications. In scenarios in which demand outstrips resource supplies, the maximum bandwidth values may not be reached. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage.
AutoRenew Boolean No true

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

  • true
  • false (default)
AutoRenewPeriod Integer No 2

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

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

InternetMaxBandwidthIn Integer No 50

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.
  • Valid values if the purchased outbound public bandwidth is greater than 10 Mbit/s: 1 to the InternetMaxBandwidthOut value. Default value: the value of InternetMaxBandwidthOut.
InternetMaxBandwidthOut Integer No 5

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

Default value: 0.

HostName String No LocalHostName

The hostname of the instance.

  • The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-).
  • For 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 (-).
Password String No TestEcs123!

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 password can contain any of the following special characters:

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

Take note of the following items:

  • To ensure security, we recommend that you use HTTPS to send requests if you specify Password.
  • 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 specified.
PasswordInherit Boolean No false

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

DeploymentSetId String No ds-bp1brhwhoqinyjd6****

The ID of the deployment set.

DeploymentSetGroupNo Integer No 1

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

ZoneId String No cn-hangzhou-g

The ID of the zone where you want to create the instance. You can call the DescribeZones operation to query the most recent zone list.

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.

By default, this parameter is empty.

ClusterId String No c-bp67acfmxazb4p****

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

Note This parameter will be removed in the future. To ensure future compatibility, we recommend that you use other parameters.
ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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.

VlanId String No 10

The ID of the virtual LAN (VLAN).

InnerIpAddress String No 192.168.**.**

The private IP address to be assigned to the instance.

SystemDisk.Size Integer No 40

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

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

SystemDisk.Category String No cloud_ssd

The category of the system disk. Valid values:

  • cloud_essd: ESSD. If you set this parameter to cloud_essd, 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 instances of other instance types, the default value is cloud_efficiency.

SystemDisk.DiskName String No SystemDiskName

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

By default, this parameter is empty.

SystemDisk.Description String No TestDescription

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

By default, this property is empty.

SystemDisk.PerformanceLevel String No PL1

The performance level of the ESSD that you want to use as a system disk. 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 million random read/write IOPS.

For more information about ESSD performance levels, see ESSDs.

NodeControllerId String No null
Note This parameter is in invitational preview and is not publicly available.
Description String No InstanceTest

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

By default, this property is empty.

VSwitchId String No vsw-bp1s5fnvk4gn2tws0****

The ID of the vSwitch to which you want to connect the instance. This parameter is required if 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.
PrivateIpAddress String No 172.16.236.*

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

IoOptimized String No optimized

Specifies whether the instance that you want to create is an I/O optimized instance. Valid values:

  • none: The instance is not I/O optimized.
  • optimized: The 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.

UseAdditionalService Boolean No true

Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud. System configurations for Windows: NTP and KMS. System configurations for Linux: NTP and YUM.

InstanceChargeType String No PrePaid

The billing method of the instance. Valid values:

  • PrePaid If you set this parameter to PrePaid, make sure that you have sufficient balance or credits in your account. Otherwise, an InvalidPayMethod error is returned.
  • PostPaid (default)
Period Integer No 1

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

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

PeriodUnit String No Month

The subscription duration. Valid values:

Month

Default value: Month.

UserData String No ZWNobyBoZWxsbyBlY3Mh

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

SpotStrategy String No NoSpot

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 instances of the compute node are preemptible instances. These types of instances have a specified 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 bidding price.
KeyPairName String No KeyPairTestName

The name of the key pair to be bound to the instance.

Note For Windows instances, this parameter is ignored By default, this parameter is empty. Password takes effect even regardless of whether you specify KeyPairName.
SpotPriceLimit Float No 0.98

The maximum hourly price of the preemptible instance. The value is accurate to three decimal places. This parameter takes effect only if SpotStrategy is set to SpotWithPriceLimit.

SpotDuration Integer No 1

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 bidding 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 biding price with the market price and checks the resource inventory to determine whether to retain or release the instance.

Alibaba Cloud sends ECS system events as notifications 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify a protection period based on your business requirements.

Note This parameter takes effect if you set SpotStrategy to SpotWithPriceLimit or SpotAsPriceGo.
SpotInterruptionBehavior String No Terminate

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

RamRoleName String No RAMTestName

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

SecurityEnhancementStrategy String No Active

Specifies whether to enable the security hardening feature. Valid values:

  • Active: enables the security hardening feature. This value applies only to public images.
  • Deactive: disables the security hardening feature. This value applies to all images.
ResourceGroupId String No rg-bp67acfmxazb4p****

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

HpcClusterId String No hpc-bp67acfmxazb4p****

The ID of the High Performance Computing (HPC) cluster to which you want to assign the instance.

DryRun Boolean No false

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.
DedicatedHostId String No dh-bp67acfmxazb4p****

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

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

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

CreditSpecification String No Standard

The performance mode of the burstable instance. Valid values:

  • Standard: the standard mode. For more information, see the "Standard mode" section in Burstable instances.
  • Unlimited: the unlimited mode. For more information, see the "Unlimited mode" section in Burstable instances.
DeletionProtection Boolean No false

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

  • true: enables release protection for the instance.
  • false (default)
Note This parameter applies only to pay-as-you-go instances. The parameter can protect instances against manual releases, but not against automatic releases.
HibernationOptions.Configured Boolean No false
Note This parameter is in invitational preview and is not publicly available.
Affinity String No default

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. If you start an instance that was is stopped in economical mode and the available resources of the original dedicated host are insufficient, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool.
  • host: associates the instance with the dedicated host. If you start an instance that is 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.

Tenancy String No default

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.

StorageSetId String No ss-bp1j4i2jdf3owlhe****

The ID of the storage set.

StorageSetPartitionNumber Integer No 2

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

HttpEndpoint String No enabled

Specifies whether the access channel is enabled for instance metadata. Valid values:

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

Default value: enabled.

Note For more information about instance metadata, see Overview of ECS instance metadata.
HttpTokens String No optional

Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata. Valid values:

  • optional: does not forcefully use the security-enhanced mode (IMDSv2).
  • required: forcefully uses the security-enhanced mode (IMDSv2). If 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.
HttpPutResponseHopLimit Integer No 0
Note This parameter is in invitational preview and is not publicly available.
PrivatePoolOptions.MatchCriteria String No Open

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

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

Default value: None.

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

  • Create a preemptible instance.
  • Create an instance in the classic network.
  • Create an instance on a dedicated host.
PrivatePoolOptions.Id String No eap-bp67acfmxazb4****

The ID of the private pool that you want to use to create the instance. The ID of a private pool is the same as the ID of the elasticity assurance or capacity reservation for which the private pool is generated.

DataDisk.N.PerformanceLevel String No PL2

The performance level of ESSD N used 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 million random read/write IOPS.

For more information about ESSD performance levels, see ESSDs.

DataDisk.N.Description String No TestDescription

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

DataDisk.N.SnapshotId String No s-bp17441ohwka0yuh****

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

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

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

  • cloud_efficiency: 20 to 32768.
  • 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 when DataDisk.N.PerformanceLevel is set to PL3: 1261 to 32768.
  • cloud: 5 to 2000.

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

DataDisk.N.Device String No /dev/xvdb

The mount point of data disk N.

Note This parameter applies 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 in the full image and modify DataDisk.N.Size and DataDisk.N.Category to change the category and size of data disk N created based on the image.
DataDisk.N.DiskName String No DataDiskName

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

DataDisk.N.Category String No cloud_ssd

The category of the data disk. 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.

DataDisk.N.DeleteWithInstance Boolean No true

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

  • true
  • false

Default value: true.

DataDisk.N.KMSKeyId String No 0e478b7a-4262-4802-b8cb-00d****

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

DataDisk.N.EncryptAlgorithm String No null
Note This parameter is not publicly available.
DataDisk.N.Encrypted Boolean No false

Specifies whether to encrypt the data disk.

  • true
  • false

Default value: false.

DataDisk.N.StorageClusterId String No dbsc-j5e1sf2vaf5he8m2****

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

Arn.N.RoleType String No Primary
Note This parameter is in invitational preview and is not publicly available.
Arn.N.Rolearn String No acs:ram::123456789012****:role/adminrole
Note This parameter is in invitational preview and is not publicly available.
Arn.N.AssumeRoleFor Long No 1234567890
Note This parameter is in invitational preview and is not publicly available.
Tag.N.key String No null

The key of tag N.

Note This parameter will be removed in the future. We recommend that you use Tag.N.Key to ensure future compatibility.
Tag.N.Key String No TestKey

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

Tag.N.Value String No TestValue

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

Tag.N.value String No null

The tag value of the resource.

Note This parameter will be removed in the future. We recommend that you use the Tag.N.Value parameter to ensure future compatibility.
SystemDisk.StorageClusterId String No dbsc-j5e1sf2vaf5he8m2****

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

Response parameters

Parameter

Type

Example

Description

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

The ID of the request.

InstanceId String i-bp67acfmxazb4p****

The ID of the instance.

OrderId String 1234567890

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

TradePrice Float 0.165

The transaction price.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=CreateInstance
&RegionId=cn-hangzhou
&ImageId=ubuntu_18_04_64_20G_alibase_20190624.vhd
&SecurityGroupId=sg-bp15ed6xe1yxeycg****
&HostName=LocalHostName
&InstanceType=ecs.g6.large
&<Common request parameters>

Sample success responses

XML format

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

<CreateInstanceResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <InstanceId>i-bp67acfmxazb4p****</InstanceId>
    <OrderId>1234567890</OrderId>
    <TradePrice>0.165</TradePrice>
</CreateInstanceResponse>

JSON format

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

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

Error codes

HttpCode

Error code

Error message

Description

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 InvalidInstanceType.ValueUnauthorized The specified InstanceType is not authorized. You cannot use the instance type.
400 InvalidInternetChargeType.ValueNotSupported The specified InternetChargeType is not valid. Invalid InternetChargeType value.
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 value of DataDisk.N.Size is invalid, or the snapshot size exceeds the limit of the specified disk category.
400 InvalidInstanceType.ValueNotSupported The specified InstanceType does not exist or beyond the permitted range. The instance type does not exist, or you are not authorized to manage instances of the instance type.
400 InvalidDescription.Malformed The specified parameter "Description" is not valid. The format of the value of Description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400 InvalidPasswordParam.Mismatch The input password should be null when passwdInherit is true. Password must be left empty if PasswdInherit is set to true.
400 InvalidDiskDescription.Malformed The specified parameter "SystemDisk.DiskDescription" or "DataDisk.n.Description" is not valid. The value of SyatemDisk.DiskDescription or DataDisk.N.Description is invalid.
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 image cannot be used for instances of the instance type.
400 ImageNotSupportCloudInit The specified image does not support cloud-init. The specified image does not support cloud-init.
400 InvalidSnapshotId.BasedSnapshotTooOld The specified snapshot is created before 2013-07-15. The specified snapshot was created before July 15, 2013.
400 InvalidMarketImageChargeType.NotSupport The specified chargeType of marketImage is unsupported. The billing method of the Alibaba Cloud Marketplace image is not supported.
400 InvalidInstanceName.Malformed The specified parameter "InstanceName" is not valid. The value of InstanceName is invalid.
400 InvalidParameter.Conflict The specified region and cluster do not match. The specified region and cluster do not match.
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. The InternetMaxBandwidthIn or InternetMaxBandwidthOut value does not match the 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 belong to the CIDR block of the specified vSwitch.
400 InvalidPrivateIpAddress.Duplicated Specified private IP address is duplicated. The specified private IP address is in use. Specify a different IP address and try again.
400 QuotaExceeded Living instances quota exceeded in this VPC. The maximum number of active instances is exceeded.
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 InvalidParameter.Mismatch Specified virtual switch is not in the specified zone. The specified vSwitch does not exist in the specified zone.
400 ResourceNotAvailable Resource you requested is not available in this region or zone. VPC is not supported by the specified region or zone.
400 InvalidIoOptimizedValue.ValueNotSupported IoOptimized value not supported. Invalid IoOptimized value.
400 InvalidPeriod The specified period is not valid. The value of 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 value of DataDisk.N.Size is invalid, or the snapshot size exceeds the limit of the specified disk category.
400 InvalidParameter The specified vm bandwidth is not valid. The specified bandwidth of the instance is invalid.
400 InvalidParameter.Bandwidth The specified parameter Bandwidth is not valid. The specified bandwidth is invalid.
400 InvalidIPAddress.AlreadyUsed The specified IPAddress is already used by other resource. The specified IP address is being used by another resource.
400 InstanceDiskNumber.LimitExceed The total number of specified disk in an instance exceeds. The maximum number of disks for the instance is exceeded.
400 Account.Arrearage Your account has an outstanding payment. You have unpaid orders in your account.
400 InvalidAutoRenewPeriod.ValueNotSupported The specified autoRenewPeriod is not valid. The value of AutoRenewPeriod is invalid.
400 QuotaExceed.AfterpayInstance The maximum number of Pay-As-You-Go instances is exceeded. Resources are insufficient to create pay-as-you-go instances of the specified instance type. Reduce the number of instances to be created.
400 InvalidSpotStrategy The specified SpotStrategy is not valid. Invalid SpotStrategy value.
400 InvalidSpotParam.EmptyZoneID The specified ZoneId is empty when SpotStrategy is set. ZoneId is not specified while SpotStrategy is specified.
400 InvalidSpotPriceLimit The specified SpotPriceLimitis not valid. The value of SpotPriceLimit is invalid.
400 InvalidSpotDuration The specified SpotDuration is not valid. The value of SpotDuration is invalid.
400 InvalidSpotAuthorized The specified Spot param is unauthorized. You are not authorized to configure SpotDuration.
400 InvalidSpotPrepaid The specified Spot type is not support PrePay Instance. Preemptible 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 preemptible instances.
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. The value of Tag.N.Key is invalid.
400 InvalidParameter.Bandwidth %s The specified bandwidth is invalid. Check the parameter values.
400 InvalidDataDiskCategory.ValueNotSupported %s The specified data disk category is invalid. %s is a variable. An error message is dynamically returned based on call conditions.
400 InvalidSystemDiskCategory.ValueNotSupported %s The system disk category does not support this operation.
400 InvalidParameter.Conflict %s The value that you specified for the parameter is invalid. Check whether parameter conflicts exist. %s is a variable. An error message is dynamically returned based on call conditions.
400 InvalidInternetChargeType.ValueNotSupported %s The value of InternetChargeType is invalid.
400 InvalidInstanceType.ValueNotSupported %s The instance type does not support this operation.
400 RegionUnauthorized %s You are not authorized to perform this operation in the region. %s is a variable. An error message is dynamically returned based on call conditions.
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 value that you specified for SystemDisk.Size is invalid.
400 InvalidDataDiskSize.ValueNotSupported %s The specified data disk size is invalid. %s is a variable. An error message is dynamically returned based on call conditions.
400 OperationDenied The 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.
400 InvalidParameter.EncryptedIllegal %s The value that you specified for the 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 value that you specified for the 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 EncryptedOption.Conflict %s The parameter that is used to encrypt disks is not supported. %s is a variable. An error message is dynamically returned based on call conditions.
400 InvalidParameter.KmsNotEnabled The specified operation need enable KMS. You must activate KMS.
400 InvalidHpcClusterId.Unnecessary The specified HpcClusterId is unnecessary. HpcClusterId is not required.
400 InvalidVSwitchId.Necessary The VSwitchId is necessary. You must specify VSwitchId.
400 InvalidHpcClusterId.Necessary The HpcClusterId is necessary. You must specify HpcClusterId.
400 InvalidHpcClusterId.NotFound The specified HpcClusterId is not found. The specified HpcClusterId value does not exist.
400 InvalidHpcClusterId.Creating The specified HpcClusterId is creating. The HPC cluster is being created.
400 InvalidPeriodUnit.ValueNotSupported The specified parameter PeriodUnit is not valid. The value of PeriodUnit is invalid.
400 IncorrectImageStatus Encrypted snapshots do not support this operation. Encrypted snapshots do not support the operation.
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. The value of Tag.N.Value is invalid.
400 InvalidSecurityGroup.NotInDefaultVpc %s The security group is not in the default VPC.
400 VpcNotFound Vpc is not found according to the specified VSwitch or the vpc does not belong to you. No VPC exists based on the specified vSwitch, or the corresponding VPC does not belong to your Alibaba Cloud account.
400 InvalidSpotInterruptionBehavior %s Invalid SpotInterruptionBehavior value.
400 OperationDenied.IllegalPaymentPolicy The current payment policy is illegal, please connect your service provider to authenticate relative agreement. The payment policy is invalid. Contact your service provider to validate the agreements that are related to the payment policy.
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. The dedicated host does not support instances that use the specified billing method.
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. This operation cannot be performed on the dedicated host in the current state.
400 IncorrectDedicatedHostStatus The current status of the resource does not support this operation. This operation cannot be performed on the resource in the current state.
400 ChargeTypeViolation.PostPaidDedicatedHost Prepaid instance onto postpaid dedicated host is not allowed. Subscription instances cannot be deployed on pay-as-you-go dedicated hosts.
400 InvalidInstanceType.ValueUnauthorized The specified InstanceType is not authorize. You are not authorized to use the instance type.
400 DedicatedHostType.Unmatched The specified DedicatedHostType doesn?t match the instance type. The specified dedicated host type does not match the specified instance type.
400 InvalidParam.Tenancy The specified Tenancy is invalid. Invalid Tenancy value.
400 InvalidParameter.CreditSpecification The specified CreditSpecification is not supported in this region. The specified credit specification is not supported in this region.
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. The image is no longer available for purchase. For more information, contact the image service provider.
400 InvalidInstanceType.NotSupported The specified instanceType is not supported by the deployment set. The instance type is not supported by the deployment set. Specify another instance type and try again.
400 InvalidVpcZone.NotSupported Zone of the specified VSwitch is not available for creating, please try in other zones. The default vSwitch cannot be created in the specified zone. Specify another zone and try again.
400 IncorrectDefaultVpcStatus The status of the default VPC is invalid. The state of the default VPC is invalid.
400 InvalidParameter.EncryptedIllegal The specified parameter Encrypted must be true when kmsKeyId is not empty. The encryption feature is disabled after a KMS key ID is specified.
400 IoOptimized.NotSupported The specified instance must be IoOptimized instance when kmsKeyId is not empty. The specified instance must be an I/O optimized instance if KMSKeyId is specified.
400 InvalidClientToken.ValueNotSupported The ClientToken provided is invalid. The value of ClientToken is invalid.
400 OperationDenied The current user does not support this operation. Your account does not support this operation.
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. The tag key already exists. Tag keys must be unique.
400 NoAvaliableDedicatedHost A dedicated host with sufficient available resources cannot be found. No available dedicated hosts exist.
400 IncorrectVSwitchStatus The current status of vSwitch does not support this operation. This operation cannot be performed on the vSwitch in the current state.
400 InvalidParameter %s The parameter is invalid.
400 InvalidOperation.EniCountExceeded The maximum number of eni in a enterprise security group is exceeded. The maximum number of ENIs in the advanced security group is exceeded.
400 AccountForbidden.ProductCreationLimited The commodity must be officially operated by Aliyun and in pay-as-you-go billing method. You can use Alibaba Cloud accounts to purchase only pay-as-you-go ECS instances. You cannot purchase third-party products such as images available on the image market. Check parameters. Make sure that all parameters meet the conditions and try again.
400 UnexpectedImageFamily.ImageIdSupplied The input parameter ImageFamily must be null when image id is set. ImageFamily must be empty if an image ID is specified.
400 InvalidHttpEndpoint.NotSupported The specified HttpEndpoint not supported, you can use enabled(default) or disabled. The value of HttpEndpoint 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 value of HttpTokens 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 value of HttpPutResponseHopLimit is invalid. The valid values of this parameter are 1 to 64.
400 InvalidPrivateIpAddress.Malformed Specified private IP address is malformed. The specified private IP address is invalid.
400 InvalidOperation.VpcHasEnabledAdvancedNetworkFeature The specified vpc has enabled advanced network feature. Advanced features are enabled for the VPC. You cannot create low-specification ECS instances in the VPC.
400 MissingParameter.PrivatePoolOptionsId The specified PrivatePoolOptions.Id should not be null. You must specify PrivatePoolOptions.Id.
400 Invalid.PrivatePoolOptionsId The specified PrivatePoolOptions.Id is invalid. The value of PrivatePoolOptions.Id is invalid.
400 Invalid.PrivatePoolOptionsId The parameter PrivatePoolOptions.Id should be null when PrivatePoolOptions.MatchCriteria is not Target. PrivatePoolOptions.Id parameter must be empty if the PrivatePoolOptions.MatchCriteria parameter is set to Open or None.
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 preemptible instances.
400 ClassicNetworkNotSupported Classic network is not supported for PrivatePool. The private pool does not support instances of the classic network type.
400 Invalid.InstanceId Instance does not exist. The specified instance does not exist.
400 Invalid.PrivatePoolOptions.MatchCriteria Target mode does not support this operation. This operation cannot be performed if PrivatePoolOptions.MatchCriteria is set to Target.
400 MissingParameter.PrivatePoolOptions.Id The specified PrivatePoolOptions.Id should not be null. You must specify PrivatePoolOptions.Id.
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 specified instance type does not match the private pool.
400 Invalid.InstanceChargeType The InstanceChargeType does not match the PrivatePool. The billing method of the specified instance does not match the specified private pool.
400 Invalid.ZoneId The ZoneId does not match the PrivatePool. The zone does not match the private pool.
400 Invalid.PrivatePoolOptions.MatchCriteria The PrivatePoolOptions.MatchCriteria does not match the PrivatePool. The PrivatePoolOptions.MatchCriteria value does not match the private pool.
400 InvalidPlatform.ValueNotSupported The Platform does not match the PrivatePool. The Platform value does not match the private pool.
400 InvalidAliUid The PrivatePool does not belong to the user of the Instance. The private pool does not belong to the user who attempted to create the instance.
400 Invalid.InstanceId The Instance dose not attached to a PrivatePool. The instance does not match the private pool.
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 for the zone. Log on to the ECS console or Quota Center to apply for a quota increase.
400 InvalidPeriod.ExceededDedicatedHost Instance expired date can not exceed dedicated host expired date. The expiration date of the instance is later than the expiration date of the dedicated host.
400 InvalidDiskCategory.NotSupported The specified disk category is not supported. The disk category does not support the operation.
400 InvalidDestinationZone.DeploymentSetMismatch Error happened, %s. Before you can add the instance to a deployment set that uses the low latency deployment strategy, make sure that the instance resides in the same zone as the instances that are already in the deployment set.
400 InvalidParameter.DedicatedRegionNotSupported The specified action is rejected because the specified ECS instance in the dedicated region does not support public IP. The ECS instances in the dedicated region do not support the parameter.
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 the RAM role policy.
403 InvalidDiskCategory.NotSupported The specified disk category is not support the specified instance type. The specified disk category does not support the instance type.
403 ImageNotSubscribed The specified image has not be subscribed. You did not subscribe to the image in Alibaba Cloud Marketplace.
403 OperationDenied The specified Image is disabled or is deleted. The image is disabled or deleted.
403 InvalidSystemDiskCategory.ValueUnauthorized The disk category is not authorized. You cannot use the disk category.
403 InvalidSnapshotId.NotReady The specified snapshot has not completed yet. The specified snapshot is being created.
403 OperationDenied The specified snapshot is not allowed to create disk. The specified snapshot cannot be used to create disks.
403 InstanceDiskCategoryLimitExceed The total size of specified disk category in an instance exceeds. The maximum disk capacity of the category for an instance is exceeded.
403 InvalidDevice.InUse The specified device has been occupied. The specified device was 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 obtained and the Alibaba Cloud Marketplace image has been removed from Alibaba Cloud Marketplace.
403 OperationDenied The creation of Instance to the specified Zone is not allowed. Instances cannot be created in the specified zone.
403 CategoryNotSupported The specified zone does not offer the specified disk category. The specified disk category is unavailable in the specified zone.
403 OperationDenied The 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 match.
403 OperationDenied.NoStock The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. The requested resources are insufficient.
403 QuotaExceed.PortableCloudDisk The quota of portable cloud disk exceeds. The maximum number of removable disks is exceeded.
403 OperationDenied Sales 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.
403 SecurityGroupInstanceLimitExceed The maximum number of instances in a security group is exceeded. The maximum number of instances in the security group is exceeded.
403 NodeControllerUnavailable The Node Controller is temporarily unavailable. The node controller is unavailable.
403 RegionUnauthorized There is no authority to create instance in the specified region. You cannot create instances in the specified region.
403 CategoryNotSupported The specified Zone or cluster does not offer the specified disk category. The specified disk category is unavailable in the specified zone or cluster.
403 InvalidSnapshotId.NotDataDiskSnapshot The specified snapshot is system disk snapshot. The specified snapshot is a system disk snapshot.
403 CategoryNotSupported The specified cluster does not offer the specified disk category. The specified disk category is unavailable in the specified cluster.
403 DeleteWithInstance.Conflict The 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.
403 InstanceDiskNumLimitExceed The number of specified disk in an instance exceeds. The maximum number of disks for an instance is exceeded.
403 IoOptimized.NotSupported The specified image is not support IoOptimized Instance. The specified image does not support I/O optimized instances.
403 ImageNotSupportInstanceType The specified image don't support the InstanceType instance. The specified image does not support the selected instance type.
403 InvalidDiskSize.TooSmall Specified disk size is less than the size of snapshot. The specified disk size is smaller than the snapshot size.
403 OperationDenied The type of the disk does not support the operation. The specified disk category does not support this operation.
403 InvalidDiskCategory.Mismatch The specified disk categories combination is not supported. The combination of disk categories is not supported.
403 IoOptimized.NotSupported Vpc is not support IoOptimized instance. The VPC does not support I/O optimized instances.
403 OperationDenied The resource is out of usage. The instance is not in the Running state. Start the instance or check whether this operation is supported.
403 QuotaExceed.BuyImage The specified image is from the image market, You have not bought it or your quota has been exceeded. You have not purchased the specified Apsara Stack Marketplace image, or your image quota was depleted.
403 InvalidVSwitchId.NotFound The VSwitchId provided does not exist in our records. The value that you specified for VSwitchId does not exist.
403 InvalidParameter.ResourceOwnerAccount ResourceOwnerAccount is Invalid. The value that you specified for ResourceOwnerAccount is invalid.
403 Zone.NotOpen The specified zone is not granted to you to buy resources yet. You are not authorized to purchase resources in the specified zone.
403 Zone.NotOnSale The specified zone is not available for purchase. The requested resources are unavailable in the specified zone. Specify another instance type or select a different region or zone, and try again.
403 InvalidClusterId.NotFound The specified clusterId does not exist. The value that you specified for ClusterId does not exist.
403 InvalidInstanceType.ZoneNotSupported The specified zone does not support this instancetype. The specified instance type is not supported in the specified zone.
403 InvalidPayMethod The specified pay method is not valid. The payment method is invalid.
403 OperationDenied.ImageNotValid The specified Image is disabled or is deleted. The specified image does not exist.
403 InvalidUserData.Base64FormatInvalid The specified UserData is not valid. The user data is invalid.
403 InstanceType.Offline %s The operation cannot be performed on the instance if the instance type is retired or if the stock of the instance type is 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 by using SSH key pairs.
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 InvalidNetworkType.MismatchRamRole Ram role cannot be applied to instances of Classic network type. Instance RAM roles can be used only for instances in VPCs, not for instances in the classic network.
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 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance. Your account balance is insufficient. Add funds to your account and try again.
403 IncorrectVpcStatus Current VPC status does not support this operation. This operation cannot be performed on the VPC in the current state.
403 InvalidParameter.NotMatch %s The parameter is invalid. Check whether parameter conflicts exist.
403 OperationDenied.InvalidNetworkType %s The network type does not support this operation.
403 InvalidSpotInterruptionBehavior.ClassicNetworkNotSupport The specified SpotInterruptionBehavior does not support Classic network Instance. The operation is not supported by instances that reside in the classic network.
403 InvalidSpotInterruptionBehavior.LocalDiskNotSupport The specified SpotInterruptionBehavior does not support local disk instance. The operation is not supported by instances to which local disks are attached.
403 OperationDenied.ImageNotValid %s The operation cannot be performed on the image.
403 QuotaExceed.PostPaidDisk Living postPaid disks quota exceeded. The maximum number of pay-as-you-go disks is exceeded.
403 OperationDenied.LocalDiskUnsupported The configuration change is not allowed when the specified instance has local disks mounted. The instance types of instances to which local disks are attached cannot be changed.
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 OperationDenied If 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 the zones of the VPC.
403 DefaultVswitch.Existed The default vswitch for VPC already exists. A default vSwitch already exists in the current VPC.
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 IncorrectInstanceStatus The current status of the resource does not support this operation. The operation cannot be performed on the resource in the current state.
403 CategoryViolation The specified instance does not support this operation because of its disk category. The configurations of instances to which local disks are attached cannot be upgraded or downgraded.
403 ResourcesNotInSameZone The specified instance and dedicated host are not in the same zone. The specified instance and dedicated host are not in the same region.
403 InvalidRegion.NotSupport The specified region does not support byok. The Bring Your Own Key (BYOK) feature is not supported in the specified region.
403 UserNotInTheWhiteList The user is not in byok white list. You cannot use the BYOK feature. Obtain the required permissions and try again.
403 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK needs to be enabled. The customer master key (CMK) must be enabled if the ID of the CMK is specified for a disk. You can call the DescribeKey operation of KMS to query the information about the CMK.
403 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service have no right to access your KMS. ECS is not authorized to access your KMS resources.
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. Risks are detected in your default credit card or debit card. Click the URL in the email for verification.
403 InvalidDisk.SystemDiskSize The specified SystemDiskSize beyond the permitted range. The maximum system disk size is exceeded.
403 InsufficientBalance Your account does not have enough balance. The account balance is insufficient. Add funds to your account and try again.
403 InvalidVSwitchId.IpInvalid %s The private IP address is invalid.
403 QuotaExceed.Tags %s The maximum number of tags is exceeded. %s is a variable. An error message is dynamically returned based on call conditions.
403 EnterpriseGroupLimited.MutliGroupType The specified instance can not join multi SecurityGroup types. The specified instance cannot belong to a basic security group and an advanced security group at the same time. You can call the DescribeSecurityGroups operation to query the type of a specific security group.
403 InternalError.AllocateUnderlayIp Allocate underlay ip for the instance error. The Underlay IP address failed to be assigned to the instance.
403 OperationDenied.CloudSSDNotSupported The specified available zone does not offer the cloud_ssd disk, use cloud_essd instead. Standard SSDs are not supported in the specified zone. Change the parameter value to cloud_essd 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 is exceeded. Specify another region or instance type, or reduce the number of instances that you want to create, and try again. You can also log on to the ECS console or the Quota Center to apply for a quota increase.
403 QuotaExceed.ElasticQuota The 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 is exceeded. Specify another region or instance type, or reduce the number of instances that you want to create, and try again. You can also log on to the ECS console or the Quota Center to apply for a quota increase.
403 QuotaExceed.ElasticQuota The number of vCPUs assigned to the ECS instances has exceeded the quota in the zone. The maximum number of vCPUs for all instance types in the zone is exceeded. You can log on to the ECS console or Quota Center to apply for a quota increase.
403 QuotaExceed.ElasticQuota The 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, or the maximum number of vCPUs for all instance types in the zone is exceeded. You can log on to the ECS console or Quota Center to apply for a quota increase.
403 QuotaExceeded.PostpaidDataDiskCapacity The quota of postpaid data disk capacity exceeds. The quota on the capacity of pay-as-you-do disks is exceeded.
403 InvalidOperation.ResourceManagedByCloudProduct %s The security groups managed by cloud services cannot be modified.
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 InvalidInstanceType.NotSupportDiskCategory The instanceType of the specified instance does not support this disk category. The instance type specified by InstanceType does not support the disk category of the instance. Specify another instance type and try again. For information about the disk categories that are supported by each instance type, see the instance family documentation.
404 InvalidSecurityGroupId.NotFound The specified SecurityGroupId does not exist. The specified security group does not exist in this account. Check whether the security group ID is valid.
404 InvalidClusterId.NotFound The ClusterId provided does not exist in our records. The value that you specified for ClusterId does not exist.
404 InvalidVSwitchId.NotFound Specified virtual switch does not exist. The value that you specified for VSwitchId does not exist.
404 InvalidImageId.NotFound The specified ImageId does not exist. The specified image does not exist within this account. Check whether the image ID is correct.
404 InvalidInstanceChargeType.NotFound The InstanceChargeType does not exist in our records. The value that you specified for InstanceChargeType does not exist.
404 DependencyViolation.IoOptimized The specified instancetype must be IoOptimized instance. The specified instance type must be an I/O optimized instance.
404 PaymentMethodNotFound No payment method has been registered on the account. You have not configured a payment method for your account.
404 InvalidSystemDiskSize.LessThanImageSize The specified parameter SystemDisk.Size is less than the image size. The specified system disk size is smaller than the image size.
404 InvalidSystemDiskSize.LessThanMinSize The specified parameter SystemDisk.Size is less than the min size. The specified system disk size is smaller than the minimum size.
404 InvalidSystemDiskSize.MoreThanMaxSize The specified SystemDisk.Size parameter exceeds the maximum size. The maximum system disk size is exceeded.
404 InvalidDataDiskSnapshotId.NotFound The specified parameter DataDisk.n.SnapshotId is not valid. Invalid DataDisk.N.SnapshotId value.
404 InvalidSystemDiskSize The specified parameter SystemDisk.Size is invalid. Invalid SystemDisk.Size value.
404 InvalidKeyPairName.NotFound The specified parameter KeyPairName does not exist in our records. The specified key pair does not exist.
404 InvalidRamRole.NotFound The specified RAMRoleName does not exist. The value that you specified for RamRoleName does not exist.
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records. The resource group does not exist.
404 InvalidMarketImage.NotFound The specified marketplace image does not exist, please change the imageId and try again. The Alibaba Cloud Marketplace image does not exist. Change the value of ImageId and try again.
404 DeploymentSet.NotFound The specified deployment set does not exist. The specified deployment set does not exist.
404 InvalidParameter.KMSKeyId.NotFound The specified KMSKeyId does not exist. The KMS key ID does not exist.
404 InvalidSecurityGroupId.NotFound %s The specified security group ID does not exist.
404 InvalidDiskIds.NotPortable The specified DiskId is not portable. The specified disk is not removable.
500 InternalError The request processing has failed due to some unknown error. An internal error occurred. Try again later.
500 InternalError %s An internal error occurred.
500 InternalError The request processing has failed due to some unknown error, exception or failure. An internal error occurred. Try again later.
500 InvalidImage.OSType The image OSType does not support this instance type. The operating system of the image does not support the specified instance type.

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