Auto Scaling：CreateScalingConfiguration

Action

String

Yes

CreateScalingConfiguration

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

ScalingGroupId

String

Yes

asg-bp14wlu85wrpchm0****

The ID of the scaling group for which you want to create a scaling configuration.

ImageId

String

No

centos6u5_64_20G_aliaegis****.vhd

The ID of the image that is used by Auto Scaling to create ECS instances.

ImageName

String

No

image****

The name of the image. The name must be unique in a region. You cannot use this parameter to specify images from Alibaba Cloud Marketplace.

InstanceType

String

No

ecs.g6.large

The ECS instance type. For more information, see Overview of instance families.

Cpu

Integer

No

2

The number of vCPUs.

You can specify the number of vCPUs and the memory size to define the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that has the lowest price.

Memory

Integer

No

16

The memory size. Unit: GiB.

You can specify the number of vCPUs and the memory size to define the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that has the lowest price.

DeploymentSetId

String

No

ds-bp1frxuzdg87zh4pz****

The ID of the deployment set to which ECS instances that you create from the scaling configuration belong.

SecurityGroupId

String

No

sg-280ih****

The ID of the security group to which ECS instances that you create from the scaling configuration belong. ECS instances that belong to the same security group can communicate with each other.

IoOptimized

String

No

optimized

Specifies whether to create I/O optimized ECS instances. Valid values:

• none: does not create I/O optimized ECS instances.

• optimized: creates I/O optimized ECS instances.

For retired instance types, the default value of this parameter is none. For other instance types, the default value of this parameter is optimized.

InternetChargeType

String

No

PayByTraffic

The billing method for network usage. Valid values:

• PayByBandwidth: You are charged for the maximum available bandwidth that is specified by InternetMaxBandwidthOut.

• PayByTraffic: You are charged for the actual amount of transferred data. InternetMaxBandwidthOut specifies only the maximum available bandwidth.

For the classic network, the default value of this parameter is PayByBandwidth. For VPCs, the default value of this parameter is PayByTraffic.

InternetMaxBandwidthIn

Integer

No

100

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

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

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

50

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

• 0 to 1024 if you set InternetChargeType to PayByBandwidth. If you leave this parameter empty, this parameter is automatically set to 0.

• 0 to 1024 if you set InternetChargeType to PayByTraffic. If you leave this parameter empty, an error is reported.

SystemDisk.Category

String

No

cloud_ssd

The category of the system disk. Valid values:

• cloud: basic disk.

• cloud_efficiency: ultra disk.

• cloud_ssd: standard SSD.

• ephemeral_ssd: local SSD.

• cloud_essd: Enterprise SSD (ESSD).

• cloud_auto: ESSD AutoPL disk.

If you specify SystemDisk.Category, you cannot specify SystemDiskCategories.N. If you do not specify SystemDisk.Category or SystemDiskCategories.N, the default value of SystemDisk.Category is used. For non-I/O optimized instances of Generation I instance types, the default value of this parameter is cloud. For instances of other types, the default value of this parameter is cloud_efficiency.

SystemDisk.Size

Integer

No

100

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

• 20 to 500 if you set SystemDisk.Category to cloud.

• 20 to 500 if you set SystemDisk.Category to cloud_efficiency.

• 20 to 500 if you set SystemDisk.Category to cloud_ssd.

• 20 to 500 if you set SystemDisk.Category to cloud_essd.

• 20 to 500 if you set SystemDisk.Category to ephemeral_ssd.

The value of SystemDisk.Size must be greater than or equal to the value of max{20, ImageSize}.

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

SystemDisk.DiskName

String

No

cloud_ssdSystem

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

SystemDisk.Description

String

No

Test system disk.

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

SystemDisk.AutoSnapshotPolicyId

String

No

sp-bp12m37ccmxvbmi5****

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

SystemDisk.PerformanceLevel

String

No

PL1

The performance level (PL) of the system disk that is an ESSD. Valid values:

• PL0: An ESSD can provide up to 10,000 random read/write IOPS.

• PL1: An ESSD can provide up to 50,000 random read/write IOPS.

• PL2: An ESSD can provide up to 100,000 random read/write IOPS.

• PL3: An ESSD can provide up to 1,000,000 random read/write IOPS.

Default value: PL1.

ScalingConfigurationName

String

No

scalingconfig****

The name of the scaling configuration. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit.

The name of the scaling configuration must be unique in a region. If you leave this parameter empty, the ID of the scaling configuration is used.

LoadBalancerWeight

Integer

No

50

The load balancing weight of each ECS instance. Valid values: 1 to 100.

Default value: 50.

Tags

String

No

{"key1":"value1","key2":"value2", ... "key5":"value5"}

The tags of ECS instances. Specify the tags as key-value pairs. You can specify up to 20 tags for each ECS instance. When you specify tag keys and tag values, take note of the following items:

• A tag key can be up to 64 characters in length. It cannot start with acs: or aliyun and cannot contain http:// or https://. You cannot specify an empty string as a tag key.

• A tag value can be up to 128 characters in length. It cannot start with acs: or aliyun and cannot contain http:// or https://. You can specify an empty string as a tag value.

UserData

String

No

ZWNobyBoZWxsbyBlY3Mh

The user data of ECS instances. Encode the user data in the Base64 format. The raw data before Base64 encoding cannot exceed 32 KB in size.

KeyPairName

String

No

KeyPairTest

The name of the key pair that you want to use to log on to ECS instances.

• Windows instances do not support this parameter.

• By default, the username and password authentication method is disabled for Linux instances.

RamRoleName

String

No

ramrole****

The name of the Resource Access Management (RAM) role that you want to attach to ECS instances. The name is provided and maintained by RAM. You can call the ListRoles operation to query the available RAM roles. You can call the CreateRole operation to create RAM roles.

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

InstanceName

String

No

instance****

The name series of ECS instances that Auto Scaling creates from the scaling configuration.

HostName

String

No

host****

The hostname series of ECS instances that Auto Scaling creates from the scaling configuration. A hostname cannot start or end with a period (.) or a hyphen (-). A hostname cannot contain consecutive periods (.) or hyphens (-). Naming conventions:

• Windows instances: A hostname must be 2 to 15 characters in length, and can contain letters, digits, and hyphens (-). It cannot contain periods (.) or contain only digits.

• Other instances, such as Linux instances: A hostname must be 2 to 64 characters in length. Separate a hostname into multiple segments with periods (.). Each segment can contain letters, digits, and hyphens (-).

SpotStrategy

String

No

NoSpot

The preemption policy that you want to apply to pay-as-you-go or preemptible instances. Valid values:

• NoSpot: The ECS instances are created as regular pay-as-you-go instances.

• SpotWithPriceLimit: The ECS instances are preemptible instances that have a user-defined maximum hourly price.

• SpotAsPriceGo: The ECS instances are created as preemptible instances for which the market price at the time of purchase is automatically used as the bidding price.

Default value: NoSpot.

PasswordInherit

Boolean

No

false

Specifies whether to use the password that is preconfigured in the image. To use this parameter, make sure that a password is configured in the specified image. Valid values:

• true

• false

Password

String

No

123abc****

The password series of ECS instances. A password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and any of the following special characters:

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

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

ResourceGroupId

String

No

rg-resource****

The ID of the resource group to which ECS instances belong.

HpcClusterId

String

No

hpc-clusterid

The ID of the Elastic High Performance Computing (E-HPC) cluster to which ECS instances belong.

InstanceDescription

String

No

Test instance.

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

ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

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 Ensure idempotence.

Ipv6AddressCount

Integer

No

1

The number of randomly generated IPv6 addresses that you want to allocate to the ENI.

CreditSpecification

String

No

Standard

The performance mode of burstable instances. Valid values:

• Standard: the standard mode.

• Unlimited: the unlimited mode.

For more information, see the "Performance modes" section in the Overview topic.

ImageFamily

String

No

hangzhou-daily-update

The name of the image family. You can specify this parameter to obtain the most recent available images in the current image family for instance creation. If you specify ImageId, you cannot specify ImageFamily.

ZoneId

String

No

cn-hangzhou-g

The zone ID of ECS instances.

DedicatedHostId

String

No

dh-bp67acfmxazb4p****

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

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

Affinity

String

No

default

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

• default: does not associate the ECS instance with the dedicated host. If you restart an instance in Economical Mode and the original dedicated host has insufficient resources, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool.

• host: associates the ECS instance with the dedicated host. If you restart an instance in Economical Mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, you cannot restart the ECS instance.

Default value: default.

Tenancy

String

No

default

Specifies whether to create ECS instances on dedicated hosts. Valid values:

• default: does not create ECS instances on dedicated hosts.

• host: creates ECS instances on dedicated hosts. If you do not specify DedicatedHostId, Alibaba Cloud automatically selects dedicated hosts to create ECS instances.

Default value: default.

SchedulerOptions

Map

No

["testManagedPrivateSpaceId****"]

The scheduling options.

PrivatePoolOptions.MatchCriteria

String

No

Open

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

• Open: open private pool. Auto Scaling selects a matching open private pool to start ECS instances. If no matching open private pools are found, Auto Scaling uses the resources in the public pool to start ECS instances. If you set this parameter to Open, you do not need to specify PrivatePoolOptions.Id.

• Target: the specified private pool. Auto Scaling uses the resources in the specified private pool to start ECS instances. If the specified private pool does not exist, the restart operation fails. If you set this parameter to Target, you must specify PrivatePoolOptions.Id.

• None: no private pool. Auto Scaling does not use the resources in private pools to start ECS instances.

PrivatePoolOptions.Id

String

No

eap-bp67acfmxazb4****

The ID of the private pool. 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.

SpotDuration

Integer

No

1

The protection period of preemptible instances. Unit: hours. Valid values:

• 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the protection period ends, Alibaba Cloud compares the bidding price with the market price and checks the resource inventory to determine whether to release the instance.

• 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance is not automatically released within 1 hour. Alibaba Cloud compares the bidding price with the market price and checks the resource inventory to determine whether to release the instance.

  Note

  Alibaba Cloud sends ECS system events to notify you 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.

Default value: 1.

SpotInterruptionBehavior

String

No

Terminate

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

InstanceTypes.N

String

No

ecs.g6.large

Instance type N. Valid values of N: 1 to 10.

The first instance type specified by this parameter has the highest priority. The priority decreases based on the specified order of instance types. Auto Scaling preferentially creates instances by using the instance type that has the highest priority. If the creation fails, Auto Scaling creates instances by using the instance type that has the next highest priority.

InstanceTypeOverride.N.InstanceType

String

No

ecs.c5.xlarge

If you want to specify the weight of an instance type in the scaling configuration, specify InstanceTypeOverride.N.WeightedCapacity after you specify InstanceTypeOverride.N.InstanceType.

This parameter specifies instance type N. You can use InstanceTypeOverride.N.InstanceType to specify multiple instance types and use InstanceTypeOverride.N.WeightedCapacity to specify weights for the instance types. Valid values of N: 1 to 10.

For information about the valid values of InstanceType in InstanceTypeOverride.N.InstanceType, see Overview of instance families.

InstanceTypeOverride.N.WeightedCapacity

Integer

No

4

If you want to specify the weight of an instance type in the scaling configuration, specify InstanceTypeOverride.N.WeightedCapacity after you specify InstanceTypeOverride.N.InstanceType. The value of N in the two parameters must be the same.

This parameter specifies the weight of instance type N. The weight specifies the capacity of an instance of instance type N in the scaling group. A higher weight specifies that a smaller number of instances of instance type N are required to achieve the expected capacity.

Performance metrics, such as the number of vCPUs and the memory size of each instance type, may vary. You can specify different weights for different instance types based on your business requirements.

Example:

• Current capacity: 0.

• Expected number: 6.

• Capacity of ecs.c5.xlarge: 4.

To achieve the expected capacity, Auto Scaling must scale out two ecs.c5.xlarge instances.

Valid values of WeightedCapacity in InstanceTypeOverride.N.WeightedCapacity: 1 to 500.

DataDisk.N.PerformanceLevel

String

No

PL1

The PL of data disk N that is an ESSD. If you set DataDisk.N.Category to cloud_essd, the value of N must be the same as the value of N in DataDisk.N.Category. Valid values:

• PL0: An ESSD can provide up to 10,000 random read/write IOPS.

• PL1: An ESSD can provide up to 50,000 random read/write IOPS.

• PL2: An ESSD can provide up to 100,000 random read/write IOPS.

• PL3: An ESSD can provide up to 1,000,000 random read/write IOPS.

Default value: PL1.

DataDisk.N.AutoSnapshotPolicyId

String

No

sp-bp19nq9enxqkomib****

The ID of the automatic snapshot policy that you want to apply to data disk N. Valid values of N: 1 to 16.

DataDisk.N.Encrypted

String

No

false

Specifies whether to encrypt data disk N. Valid values of N: 1 to 16. Valid values of this parameter:

• true

• false

Default value: false.

DataDisk.N.Description

String

No

Test data disk.

The description of data disk N. Valid values of N: 1 to 16. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with http:// or https://.

DataDisk.N.SnapshotId

String

No

s-280s7****

The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored. The size of the data disk is the same as the size of the specified snapshot.

If you specify a snapshot that is created on or before July 15, 2013, the operation fails and InvalidSnapshot.TooOld is returned.

DataDisk.N.Categories.N

String

No

cloud

Category N of data disk N. The first N in DataDisk.N.Categories.N represents the serial number of the data disk. Valid values of the first N: 1 to 16. The second N in DataDisk.N.Categories.N represents the serial number of the data disk category. Valid values of the second N: 1 to 4. A smaller value of N specifies a higher priority. If Auto Scaling cannot create disks by using the disk category that has the highest priority, it creates disks by using the disk category that has the next highest priority. Valid values:

• cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with an ECS instance is set to true.

• cloud_efficiency: ultra disk.

• cloud_ssd: standard SSD.

• cloud_essd: ESSD.

DataDisk.N.Size

Integer

No

100

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

• 5 to 2000 if you set DataDisk.N.Category to cloud.

• 20 to 32768 if you set DataDisk.N.Category to cloud_efficiency.

• 20 to 32768 if you set DataDisk.N.Category to cloud_ssd.

• 20 to 32768 if you set DataDisk.N.Category to cloud_essd.

• 5 to 800 if you set DataDisk.N.Category to ephemeral_ssd.

The size of data disk N must be greater than or equal to the size of the snapshot that is specified by SnapshotId.

DataDisk.N.Device

String

No

/dev/xvdb

The mount target of data disk N. Valid values of N: 1 to 16. If you leave this parameter empty, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.

DataDisk.N.DiskName

String

No

cloud_ssdData

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

DataDisk.N.Category

String

No

cloud_ssd

The category of data disk N. Valid values of N: 1 to 16. Valid values of this parameter:

• cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with an ECS instance is set to true.

• cloud_efficiency: ultra disk.

• cloud_ssd: standard SSD.

• ephemeral_ssd: local SSD.

• cloud_essd: ESSD.

• cloud_auto: ESSD AutoPL disk.

If you specify DataDisk.N.Category, you cannot specify DataDisk.N.Categories.N. If you do not specify DataDisk.N.Category or DataDisk.N.Categories.N, the default value of DataDisk.N.Category is used.

• For I/O optimized instances, the default value of this parameter is cloud_efficiency.

• For non-I/O optimized instances, the default value of this parameter is cloud.

DataDisk.N.DeleteWithInstance

Boolean

No

true

Specifies whether to release data disk N when the ECS instance to which data disk N is attached is released. Valid values of N: 1 to 16. Valid values of this parameter:

• true

• false

This parameter is available only for independent disks whose DataDisk.N.Category is set to cloud, cloud_efficiency, cloud_ssd, cloud_essd, or cloud_auto. If you specify this parameter for other disks, an error is reported.

Default value: true.

DataDisk.N.KMSKeyId

String

No

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

The ID of the Key Management Service (KMS) key that you want to use to encrypt data disk N. Valid values of N: 1 to 16.

DataDisk.N.ProvisionedIops

Long

No

100

The provisioned IOPS of data disk N.

DataDisk.N.BurstingEnabled

Boolean

No

false

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

• true

• false

  Note

  This parameter takes effect only if you set DataDisk.Category to cloud_auto.

For more information, see ESSD AutoPL disks.

SpotPriceLimit.N.PriceLimit

Float

No

0.5

The price limit of preemptible instance N. Valid values of N: 1 to 10. This parameter takes effect only if you set SpotStrategy to SpotWithPriceLimit.

SpotPriceLimit.N.InstanceType

String

No

ecs.g6.large

The instance type of preemptible instance N. Valid values of N: 1 to 10. This parameter takes effect only if you set SpotStrategy to SpotWithPriceLimit.

SecurityGroupIds.N

String

No

sg-bp18kz60mefs****

The ID of security group N to which ECS instances belong. The valid values of N vary based on the security group quota of each ECS instance. For more information, see the "Security group limits" section in the Limits topic.

InstancePatternInfo.N.Cores

Integer

No

2

The number of vCPUs that you want to allocate to instance type N in intelligent configuration mode. You can specify this parameter to obtain the instance types that meet the specified criteria. For more information, see Overview of instance families. Valid values of N: 1 to 10.

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

• InstancePatternInfo.N is available only for scaling groups that reside in VPCs.

• If you specify InstancePatternInfo.N, you must specify InstancePatternInfo.N.Cores and InstancePatternInfo.N.Memory.

• If you specify an instance type by using InstanceType or InstanceTypes.N, Auto Scaling preferentially uses the instance type that is specified by InstanceType or InstanceTypes.N during scale-out events. If the specified instance type has insufficient inventory, Auto Scaling uses the lowest-priced instance type that is specified by InstancePatternInfo.N during scale-out events.

InstancePatternInfo.N.InstanceFamilyLevel

String

No

EnterpriseLevel

The level of instance type N in intelligent configuration mode. You can specify this parameter to obtain the instance types that meet the specified criteria. Valid values:

• EntryLevel: entry level (shared instance type). Instance types of this level are the most cost-effective but may not ensure consistent computing performance. Instance types of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see Shared instance families.

• EnterpriseLevel: enterprise level. Instance types of this level provide stable performance and dedicated resources and are suitable for business scenarios that require high stability. For more information, see Overview of instance families.

• CreditEntryLevel: credit entry level (burstable instance types). CPU credits are used to ensure computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see Overview of burstable instances.

Valid values of N: 1 to 10.

InstancePatternInfo.N.MaxPrice

Float

No

2

The maximum price per hour of pay-as-you-go instance N or preemptible instance N in intelligent configuration mode. You can specify this parameter to obtain the instance types that meet the specified criteria. Valid values of N: 1 to 10.

InstancePatternInfo.N.Memory

Float

No

4

The memory size of instance type N in intelligent configuration mode. Unit: GiB. You can specify this parameter to obtain the instance types that meet the specified criteria. For more information, see Overview of instance families. Valid values of N: 1 to 10.

InstancePatternInfo.N.ExcludedInstanceType.N

String

No

ecs.n1.small/ecs.n1.*/*7*

Instance type N that you want to exclude. You can use the asterisk (*) wildcard character to exclude an instance type or instance family. Examples:

• ecs.c6.large: excludes the ecs.c6.large instance type.

• ecs.c6.*: excludes the c6 instance family.

InstancePatternInfo.N.Architecture.N

String

No

X86

The architecture type of instance type N. Valid values:

• X86: x86.

• Heterogeneous: heterogeneous computing, such as GPUs and FPGAs.

• BareMetal: ECS Bare Metal Instance.

• Arm: Arm.

• SuperComputeCluster: Super Computing Cluster (SCC).

By default, all values are selected.

InstancePatternInfo.N.BurstablePerformance

String

No

Include

Specifies whether to include burstable instance types. Valid values:

• Exclude: does not include burstable instance types.

• Include: includes burstable instance types.

• Required: includes only burstable instance types.

Default value: Include.

InstancePatternInfo.N.InstanceTypeFamilies.N

String

No

ecs.g6

Instance family N. Valid values of N: 1 to 10.

InstancePatternInfo.N.MinimumCpuCoreCount

Integer

No

2

The minimum number of vCPUs per instance type.

InstancePatternInfo.N.MaximumCpuCoreCount

Integer

No

4

The maximum number of vCPUs per instance type.

InstancePatternInfo.N.GpuSpecs.N

String

No

NVIDIA V100

The GPU model.

InstancePatternInfo.N.InstanceCategories.N

String

No

Compute-optimized with GPU

Category N of ECS instances. Valid values:

• General-purpose

• Compute-optimized

• Memory-optimized

• Big data

• Local SSDs

• High Clock Speed

• Enhanced

• Shared

• Compute-optimized with GPU

• Visual Compute-optimized

• Heterogeneous Service

• Compute-optimized with FPGA

• Compute-optimized with NPU

• ECS Bare Metal

• Super Computing Cluster

• High Performance Compute

InstancePatternInfo.N.CpuArchitectures.N

String

No

X86

CPU architecture N of ECS instances. Valid values:

• X86

• Arm

InstancePatternInfo.N.PhysicalProcessorModels.N

String

No

Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY

Processor model N of ECS instances. Valid values of N: 1 to 10.

InstancePatternInfo.N.MinimumEniQuantity

Integer

No

2

The minimum number of ENIs per instance.

InstancePatternInfo.N.MinimumEniPrivateIpAddressQuantity

Integer

No

2

The minimum number of IPv4 addresses per ENI.

InstancePatternInfo.N.MinimumEniIpv6AddressQuantity

Integer

No

1

The minimum number of IPv6 addresses per ENI.

InstancePatternInfo.N.MinimumInitialCredit

Integer

No

12

The initial vCPU credits per t5 or t6 burstable instance.

InstancePatternInfo.N.MinimumBaselineCredit

Integer

No

12

The initial vCPU credits per t5 or t6 burstable instance.

InstancePatternInfo.N.MinimumMemorySize

Float

No

4

The minimum memory size per instance. Unit: GiB.

InstancePatternInfo.N.MaximumMemorySize

Float

No

4

The maximum memory size per instance. Unit: GiB.

InstancePatternInfo.N.MinimumGpuAmount

Integer

No

2

The minimum number of GPUs per instance. The value must be a positive integer.

InstancePatternInfo.N.MaximumGpuAmount

Integer

No

2

The maximum number of GPUs per instance. The value must be a positive integer.

SystemDiskCategories.N

String

No

cloud

Category N of the system disk. Valid values of N: 1 to 4. A smaller value of N specifies a higher priority. If Auto Scaling cannot create disks by using the disk category that has the highest priority, it creates disks by using the disk category that has the next highest priority. Valid values:

• cloud: basic disk.

• cloud_efficiency: ultra disk.

• cloud_ssd: standard SSD.

• cloud_essd: ESSD.

SystemDisk.Encrypted

Boolean

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 that you want to use to encrypt the system disk.

SystemDisk.EncryptAlgorithm

String

No

AES-256

The algorithm that you want to use to encrypt the system disk. Valid values:

• AES-256

• SM4-128

Default value: AES-256.

SystemDisk.ProvisionedIops

Long

No

100

The provisioned IOPS of the system disk.

SystemDisk.BurstingEnabled

Boolean

No

false

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

• true

• false

  Note

  This parameter takes effect only if you set SystemDisk.Category to cloud_auto.

For more information, see ESSD AutoPL disks.

ImageOptions.LoginAsNonRoot

Boolean

No

false

Specifies whether to use ecs-user to log on to an ECS instance. For more information, see Manage the username used to log on to an ECS instance. Valid values:

• true

• false

Default value: false.

DeletionProtection

Boolean

No

false

Specifies whether to enable the Release Protection feature for ECS instances. This parameter is available only for pay-as-you-go instances. You can use this parameter to specify whether an ECS instance can be directly released in the ECS console or by calling the DeleteInstance operation. Valid values:

• true: enables the Release Protection feature. In this case, you cannot release ECS instances in the ECS console or by calling the DeleteInstance operation.

• false: disables the Release Protection feature. In this case, you can release ECS instances in the ECS console or by calling the DeleteInstance operation.

Default value: false.

StorageSetId

String

No

ss-bp67acfmxazb4p****

The ID of the storage set.

StorageSetPartitionNumber

Integer

No

2

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

CustomPriorities.N.InstanceType

String

No

ecs.g6.large

You can use CustomPriorities to specify the priority of a custom ECS instance type + vSwitch combination. CustomPriorities.N.InstanceType specifies the ECS instance type in a custom combination.

If Auto Scaling cannot create ECS instances by using the ECS instance type + vSwitch combination that has the highest priority, it automatically creates ECS instances by using the ECS instance type + vSwitch combination that has the next highest priority.

CustomPriorities.N.VswitchId

String

No

vsw-bp14zolna43z266bq****

You can use CustomPriorities.N.VswitchId to specify the vSwitch ID in a custom ECS instance type + vSwitch combination.

NetworkInterfaces.N.InstanceType

String

No

Primary

The ENI type. If you specify NetworkInterfaces.N, specify at least one primary ENI. You cannot specify SecurityGroupId or SecurityGroupIds.N. Valid values:

• Primary: the primary ENI.

• Secondary: the secondary ENI.

Default value: Secondary.

NetworkInterfaces.N.NetworkInterfaceTrafficMode

String

No

HighPerformance

The communication mode of the ENI. Valid values:

• Standard: uses the TCP communication mode.

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

Default value: Standard.

NetworkInterfaces.N.Ipv6AddressCount

Integer

No

1

The number of randomly generated IPv6 addresses that you want to assign to primary ENI N. When you specify this parameter, take note of the following items:

• This parameter takes effect only if you set NetworkInterfaces.N.InstanceType to Primary.

• If you set NetworkInterface.N.InstanceType to Secondary or leave the parameter empty, this parameter is not supported.

• If you specify this parameter, you cannot specify Ipv6AddressCount.

NetworkInterfaces.N.SecurityGroupIds.N

String

No

sg-uf6ij8dwxh****

The ID of security group N to which ENI N belongs. When you specify this parameter, take note of the following items:

• If you set NetworkInterfaces.N.InstanceType to Primary, you must specify this parameter. In this case, this parameter provides the same effect as SecurityGroupIds.N. You cannot specify SecurityGroupId or SecurityGroupIds.N.

• If you set NetworkInterfaces.N.InstanceType to Secondary or leave the parameter empty, this parameter is optional. The default value of this parameter is the same as the security group to which ECS instances belong.

DedicatedHostClusterId

String

No

dc-2zedxc67zqzt7lb4****

The ID of the dedicated host cluster.

SecurityOptions.ConfidentialComputingMode

String

No

TDX

The confidential computing mode. Valid values:

• Enclave: builds an enclave-based confidential computing environment on each ECS instance. For more information, see Build a confidential computing environment by using Enclave.

• TDX: builds a Trust Domain Extensions (TDX) confidential computing environment on each ECS instance. For more information, see Build a TDX confidential computing environment.

ScalingConfigurationId

String

asc-bp1ffogfdauy0nu5****

The scaling configuration ID.

RequestId

String

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

The request ID.