Action

String

Yes

RunInstances

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

RegionId

String

Yes

cn-hangzhou

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

ImageId

String

No

aliyun_2_1903_x64_20G_alibase_20200324.vhd

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

ImageFamily

String

No

hangzhou-daily-update

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

• If you specify ImageId, you cannot specify ImageFamily.

• If you do not specify ImageId but use the LaunchTemplateId or LaunchTemplateName parameter to specify a launch template that has the ImageId parameter specified, you cannot specify ImageFamily.

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

• If you do not specify ImageId, LaunchTemplateId, or LaunchTemplateName, you can specify ImageFamily.

InstanceType

String

No

ecs.g6.large

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

• Select an instance type. You can see Overview of instance families or call the DescribeInstanceTypes operation to query the performance data of an instance type, or see Select instance types to learn about how to select instance types.

• Query available resources. Call the DescribeAvailableResource operation to query resources available in a specific region or zone.

SecurityGroupId

String

No

sg-bp15ed6xe1yxeycg7****

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

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

• You can set SecurityGroupId to specify a single security group or set SecurityGroupIds.N to specify one or more security groups. However, you cannot specify both SecurityGroupId and SecurityGroupIds.N.

• If NetworkInterface.N.InstanceType is set to Primary, you cannot specify SecurityGroupId or SecurityGroupIds.N but can specify NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N.

VSwitchId

String

No

vsw-bp1s5fnvk4gn2tws0****

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

Take note of the following items:

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

• If NetworkInterface.N.InstanceType is set to Primary, you cannot specify VSwitchId but can specify NetworkInterface.N.VSwitchId.

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 and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The default value of this parameter is the InstanceId value.

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

Description

String

No

Instance_Description

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

InternetMaxBandwidthIn

Integer

No

10

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.

InternetMaxBandwidthOut

Integer

No

10

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

Default value: 0.

HostName

String

No

k8s-node-[1,4]-ecshost

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

• The hostname cannot start or end with a period (.) or hyphen (-). 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 instances that run other operating systems such as Linux, take note of the following items:

  • The hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

  • You can use the ${instance_id} placeholder to pass instance IDs into the hostname specified by HostName. For example, if you set HostName to k8s-${instance_id} and the instance is assigned an ID of i-123abc****, the hostname of the instance is k8s-i-123abc****.

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

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

• Use HostNames.N to configure different hostnames for instances. You cannot specify both HostName and HostNames.N.

UniqueSuffix

Boolean

No

true

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

• true: appends incremental suffixes to the hostname and the instance name.

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

Default value: false.

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

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

Password

String

No

EcsV587!

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 the following special characters:

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

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

PasswordInherit

Boolean

No

false

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

• true

• false

Default value: false.

ZoneId

String

No

cn-hangzhou-g

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

This parameter is empty by default.

InternetChargeType

String

No

PayByTraffic

The billing method for network usage. Valid values:

• PayByBandwidth

• PayByTraffic

Default value: PayByTraffic.

SystemDisk.Size

String

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 size of the specified image.

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

SystemDisk.Category

String

No

cloud_ssd

The category of the system disk. Valid values:

• cloud_efficiency: ultra disk

• cloud_ssd: standard SSD

• cloud_essd: enhanced SSD (ESSD)

• cloud: basic disk

• cloud_auto: ESSD AutoPL disk

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

SystemDisk.DiskName

String

No

cloud_ssdSystem

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

SystemDisk.Description

String

No

SystemDisk_Description

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

SystemDisk.PerformanceLevel

String

No

PL0

The performance level of the ESSD to use as the 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,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSDs.

SystemDisk.AutoSnapshotPolicyId

String

No

sp-bp67acfmxazb4p****

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

IoOptimized

String

No

optimized

Specifies whether the instance that you want to create is an I/O optimized instance. For instances of retired instance types, the default value is none. For instances of other instance types, the default value is optimized. Valid values:

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

• optimized: The instance is I/O optimized.

UserData

String

No

ZWNobyBoZWxsbyBlY3Mh

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

KeyPairName

String

No

KeyPair_Name

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

RamRoleName

String

No

RAM_Name

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.

Amount

Integer

No

3

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

Default value: 1.

MinAmount

Integer

No

2

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

• If the number of instances that available resources are sufficient to create is smaller than the MinAmount value, instances cannot be created.

• If the number of instances that available resources are sufficient to create is greater than or equal to the MinAmount value, instances are created based on the number of available resources.

AutoReleaseTime

String

No

2018-01-01T12:05:00Z

The time when to automatically release the pay-as-you-go instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

• If the value of ss is not 00, the start time is automatically rounded to the nearest minute based on the value of mm.

• The specified time must be at least 30 minutes later than the current time.

• The specified time can be at most three years later than the current time.

SpotStrategy

String

No

NoSpot

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

• NoSpot: The instance is created as a pay-as-you-go instance.

• SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.

• SpotAsPriceGo: The instance is created as a preemptible instance whose bidding price is based on the market price at the time of purchase.

Default value: NoSpot.

SpotDuration

Integer

No

1

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

• The following protection periods are in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket.

• If this parameter is set to 0, no protection period is configured for the preemptible instance.

Default value: 1.

SpotPriceLimit

Float

No

0.97

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

SpotInterruptionBehavior

String

No

Terminate

The interruption mode of the preemptible instance. Default value: Terminate. Set the value to Terminate. This value specifies that the preemptible instance is to be released.

SecurityEnhancementStrategy

String

No

Active

Specifies whether to enable security hardening. Valid values:

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

• Deactive: does not enable security hardening. This value is applicable to all image types.

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 value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

HpcClusterId

String

No

hpc-bp67acfmxazb4p****

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

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

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

DedicatedHostId

String

No

dh-bp67acfmxazb4p****

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

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

LaunchTemplateId

String

No

lt-bp1apo0bbbkuy0rj****

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

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

LaunchTemplateName

String

No

LaunchTemplate_Name

The name of the launch template.

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

LaunchTemplateVersion

Long

No

3

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

ResourceGroupId

String

No

rg-bp67acfmxazb4p****

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

Period

Integer

No

1

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

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

PeriodUnit

String

No

Month

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

Month

AutoRenew

Boolean

No

true

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

• true

• false

Default value: false.

AutoRenewPeriod

Integer

No

1

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

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

Default value: 1.

InstanceChargeType

String

No

PrePaid

The billing method of the instance. Valid values:

• PrePaid: subscription

• PostPaid: pay-as-you-go

Default value: PostPaid.

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

DeploymentSetId

String

No

ds-bp1brhwhoqinyjd6****

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

DeploymentSetGroupNo

Integer

No

1

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.

PrivateIpAddress

String

No

10.1.**.**

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

Take note of the following items:

• If the PrivateIpAddress parameter is specified, take note of the following items:

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

  • If Amount is set to a numeric value greater than 1, the specified number of instances are created and consecutive private IP addresses starting from the specified one are assigned to the instances. In this case, you cannot specify parameters that start with NetworkInterface.N to attach secondary ENIs to the instances.

• If NetworkInterface.N.InstanceType is set to Primary, you cannot specify PrivateIpAddress but can specify NetworkInterface.N.PrimaryIpAddress.

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.

Ipv6AddressCount

Integer

No

1

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

Take note of the following items:

• You cannot specify both Ipv6Addresses.N and Ipv6AddressCount.

• If NetworkInterface.N.InstanceType is set to Primary, you cannot specify Ipv6Address.N or Ipv6AddressCount but can specify NetworkInterface.N.Ipv6Address.N or NetworkInterface.N.Ipv6AddressCount.

NetworkInterfaceQueueNumber

Integer

No

8

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

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

• The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type. To query the maximum number of queues per ENI and the queue quota for an instance type, you can call the DescribeInstanceTypes operation and check the MaximumQueueNumberPerEni and TotalEniQueueQuantity values in the response.

• If NetworkInterface.N.InstanceType is set to Primary, you cannot specify NetworkInterfaceQueueNumber but can specify NetworkInterface.N.QueueNumber.

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

• false

Default value: false.

HibernationOptions.Configured

Boolean

No

false

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

• host: associates the instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host of the instance has insufficient resources, the instance cannot be started.

Default value: default.

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-bp67acfmxazb4p****

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.

CpuOptions.Core

Integer

No

2

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

CpuOptions.ThreadsPerCore

Integer

No

2

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

• If CpuOptionsThreadPerCore is set to 1, hyperthreading is disabled.

• This parameter is applicable only to specific instance types.

CpuOptions.Numa

String

No

1

This parameter is no longer used.

SecurityOptions.TrustedSystemMode

String

No

vTPM

The trusted system mode. Set the value to vTPM.

The trusted system mode supports the following instance families:

• g7, c7, and r7

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

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

• To use the Alibaba Cloud trusted system, set this parameter to vTPM. Then, the Alibaba Cloud trusted system performs trust verifications when the instances start.

• If you do not want to use the Alibaba Cloud trusted system, leave this parameter empty. Take note that if your created instances use an enclave-based confidential computing environment (with SecurityOptions.ConfidentialComputingMode set to Enclave), the Alibaba Cloud trusted system is enabled for the instances.

• When you use the ECS API to create instances that use the trusted system, you can call only the RunInstances operation. The CreateInstance operation does not support the SecurityOptions.TrustedSystemMode parameter.

  Note

  If you have configured an instance as a trusted one when you created the instance, you can use only an image that supports the trusted system to replace the system disk of the instance.

For more information about the trusted system, see Overview.

SecurityOptions.ConfidentialComputingMode

String

No

Enclave

The confidential computing mode. Set the value to Enclave.

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

• The confidential computing feature is in invitational preview.

• When you use the ECS API to create instances that support enclave-based confidential computing, you can call only the RunInstances operation. The CreateInstance operation does not support the SecurityOptions.ConfidentialComputingMode parameter.

• Enclave-based confidential computing is implemented based on the Alibaba Cloud trusted system (vTPM). When you build a confidential computing environment on an instance by using Enclave, the Alibaba Cloud trusted system is enabled for the instance. If you set SecurityOptions.ConfidentialComputingMode to Enclave when you call this operation, the created instances use enclave-based confidential computing and the Alibaba Cloud trusted system regardless of whether SecurityOptions.TrustedSystemMode is set to vTPM.

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

HttpEndpoint

String

No

enabled

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

• enabled

• disabled

Default value: enabled.

HttpTokens

String

No

optional

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

• optional: does not forcefully use the security-enhanced mode (IMDSv2).

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

Default value: optional.

HttpPutResponseHopLimit

Integer

No

3

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

Default value: 1.

PrivatePoolOptions.MatchCriteria

String

No

Open

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

• Open: open private pool. The system selects a matching open private pool to create the instance. If no matching open private pools are found, resources in the public pool are used. When you set this parameter to Open, you can leave PrivatePoolOptions.Id empty.

• Target: specified private pool. The capacity in a specified private pool is used. If the specified private pool is unavailable, the instance cannot be created. If you set this parameter to Target, you must 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 to use to create the instance. 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.

Isp

String

No

null

SchedulerOptions.DedicatedHostClusterId

String

No

dc-bp12wlf6am0vz9v2****

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

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

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

• If the specified dedicated host does not belong to the specified dedicated host cluster, the instance cannot be created.

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

SecurityGroupIds.N

String

No

sg-bp15ed6xe1yxeycg7****

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

Take note of the following items:

• You cannot specify both SecurityGroupId and SecurityGroupIds.N.

• If NetworkInterface.N.InstanceType is set to Primary, you cannot specify SecurityGroupId or SecurityGroupIds.N but can specify NetworkInterface.N.SecurityGroupId or NetworkInterface.N.SecurityGroupIds.N.

HostNames.N

String

No

ecs-host-01

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

• The maximum value of N must be the same as the Amount value. For example, if you set Amount to 2, you can use HostNames.1 and HostNames.2 to specify hostnames for the individual instances. Examples: HostNames.1=test1 and HostNames.2=test2.

• You cannot specify both HostName and HostNames.N.

• 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 instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

DataDisk.N.PerformanceLevel

String

No

PL1

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.

DataDisk.N.AutoSnapshotPolicyId

String

No

sp-bp67acfmxazb4p****

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

DataDisk.N.Encrypted

String

No

false

Specifies whether to encrypt data disk N. Valid values:

• true

• false

Default value: false.

DataDisk.N.Description

String

No

DataDisk_Description

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

DataDisk.N.SnapshotId

String

No

s-bp17441ohwka0yuh****

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

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

DataDisk.N.Device

String

No

/dev/xvdb

The mount point of data disk N.

DataDisk.N.Size

Integer

No

2000

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

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

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

• Valid values when DataDisk.N.Category is set to cloud_essd: depends on the value of DataDisk.N.PerformanceLevel.

  • Valid values when DataDisk.N.PerformanceLevel is set to PL0: 40 to 32768.

  • Valid values when the PerformanceLevel parameter is set to PL1: 20 to 32768.

  • Valid values when the PerformanceLevel parameter is set to PL2: 461 to 32768.

  • Valid values when the DataDisk.N.PerformanceLevel parameter is set to PL3: 1261 to 32768.

• Valid values when DataDisk.N.Category is set to cloud: 5 to 2000.

• Valid values when DataDisk.N.Category is set to cloud_auto: 40 to 32768.

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

DataDisk.N.DiskName

String

No

cloud_ssdData

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

DataDisk.N.Category

String

No

cloud_ssd

The category of data disk N. Valid values:

• cloud_efficiency: ultra disk

• cloud_ssd: standard SSD

• cloud_essd: ESSD

• cloud: basic disk

• cloud_auto: ESSD AutoPL disk

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

DataDisk.N.EncryptAlgorithm

String

No

null

DataDisk.N.DeleteWithInstance

Boolean

No

true

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

• true

• false

Default value: true.

DataDisk.N.KMSKeyId

String

No

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

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

DataDisk.N.StorageClusterId

String

No

dbsc-j5e1sf2vaf5he8m2****

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

DataDisk.N.ProvisionedIops

Long

No

40000

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

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

DataDisk.N.BurstingEnabled

Boolean

No

false

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

• true

• false

Arn.N.RoleType

String

No

null

This parameter is not publicly available.

Arn.N.Rolearn

String

No

null

This parameter is not publicly available.

Arn.N.AssumeRoleFor

Long

No

0

This parameter is not publicly available.

NetworkInterface.N.VSwitchId

String

No

vsw-bp67acfmxazb4p****

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

Take note of the following items:

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

• If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. In this case, this parameter is equivalent to VSwitchId. You cannot specify both NetworkInterface.N.VSwitchId and VSwitchId.

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

NetworkInterface.N.NetworkInterfaceName

String

No

Network_Name

The name of ENI N.

Take note of the following items:

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

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

NetworkInterface.N.Description

String

No

Network_Description

The description of ENI N.

Take note of the following items:

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

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

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

NetworkInterface.N.SecurityGroupId

String

No

sg-bp67acfmxazb4p****

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

Take note of the following items:

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

• If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. In this case, this parameter is equivalent to SecurityGroupId. You cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N.

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

NetworkInterface.N.PrimaryIpAddress

String

No

172.16.**.**

The primary IP address to assign to ENI N.

Take note of the following items:

• Valid values of N: 1 and 2.

  • If the value of N is 1, you can configure a primary or secondary ENI. If this parameter is specified, Amount is set to a numeric value greater than 1, and NetworkInterface.N.InstanceType is set to Primary, the specified number of instances are created and consecutive primary IP addresses starting from the specified one are assigned to the instances. In this case, you cannot attach secondary ENIs to the instances.

  • If the value of N is 2, you must configure a primary ENI and a secondary ENI. If this parameter is specified, Amount is set to a numeric value greater than 1, and NetworkInterface.N.InstanceType is set to Primary, you cannot set NetworkInterface.2.InstanceType to Secondary to attach a secondary ENI.

• If NetworkInterface.N.InstanceType is set to Primary, this parameter is equivalent to PrivateIpAddress and you cannot specify both NetworkInterface.N.PrimaryIpAddress and PrivateIpAddress.

• If NetworkInterface.N.InstanceType is set to Secondary or left empty, the specified primary IP address is assigned to the secondary ENI. The default value is an IP address that is randomly selected from within the CIDR block of the vSwitch to which to connect the secondary ENI.

NetworkInterface.N.QueueNumber

Integer

No

8

The number of queues supported by ENI N.

Take note of the following items:

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

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

• The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type. To learn the maximum number of queues per ENI and the queue quota for an instance type, you can call the DescribeInstanceTypes operation to query the MaximumQueueNumberPerEni and TotalEniQueueQuantity values.

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

NetworkInterface.N.SecurityGroupIds.N

String

No

sg-bp15ed6xe1yxeycg7****

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

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

• The second N indicates that one or more security group IDs can be specified. The valid values of N vary based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in Limits.

Take note of the following items:

• If NetworkInterface.N.InstanceType is set to Primary, you must specify this parameter or NetworkInterface.N.SecurityGroupId. In this case, this parameter is equivalent to SecurityGroupIds.N. You cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.

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

NetworkInterface.N.NetworkInterfaceTrafficMode

String

No

Standard

The communication mode of ENI N. Valid values:

• Standard: uses the TCP communication mode.

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

Default value: Standard.

NetworkInterface.N.QueuePairNumber

Long

No

0

The number of queues supported by the ERI.

NetworkInterface.N.InstanceType

String

No

Secondary

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

Valid values:

• Primary

• Secondary

Default value: Secondary.

NetworkInterface.N.Ipv6AddressCount

Long

No

1

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

Take note of the following items:

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

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

NetworkInterface.N.Ipv6Address.N

String

No

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

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

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

Take note of the following items:

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

• If you specify this parameter, you must set Amount to 1 and cannot specify Ipv6AddressCount, Ipv6Address.N, or NetworkInterface.N.Ipv6AddressCount.

NetworkInterface.N.NetworkCardIndex

Integer

No

0

The index of the network card for ENI N.

Take note of the following items:

• You can specify network card indexes only for instances of specific instance types.

• When NetworkInterface.N.InstanceType is set to Primary, you can set NetworkInterface.N.NetworkCardIndex only to 0 for instance types that support network cards.

• When NetworkInterface.N.InstanceType is set to Secondary or left empty, you can set NetworkInterface.N.NetworkCardIndex based on instance types if the instance types support network cards. For more information, see Overview of instance families.

Tag.N.Key

String

No

TestKey

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

Tag.N.Value

String

No

TestValue

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

Ipv6Address.N

String

No

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

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

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

Take note of the following items:

• If the Ipv6Address.N parameter is specified, you must set Amount to 1 and leave Ipv6AddressCount empty.

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

SystemDisk.StorageClusterId

String

No

dbsc-j5e1sf2vaf5he8m2****

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

SystemDisk.ProvisionedIops

Long

No

40000

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

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

SystemDisk.BurstingEnabled

Boolean

No

false

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

• true

• false

SystemDisk.Encrypted

String

No

false

Specifies whether to encrypt the system disk. Valid values:

• true

• false

Default value: false.

SystemDisk.KMSKeyId

String

No

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

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

SystemDisk.EncryptAlgorithm

String

No

null

ImageOptions.LoginAsNonRoot

Boolean

No

false

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

• true

• false

NetworkOptions.EnableJumboFrame

Boolean

No

false

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

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

• true: enables the Jumbo Frame feature for the instance. The MTU value of all ENIs on the instance is set to 8500.

Default value: true.

AutoPay

Boolean

No

true

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

• true: The payment is automatically completed.

  Note

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

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

  Note

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

Default value: true.

RequestId

String

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

The ID of the request.

OrderId

String

123456****

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

TradePrice

Float

0.165

The transaction price.

InstanceIdSets

Array of String

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

The IDs of the instances (InstanceIdSet).