CreateScalingConfiguration

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

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

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

The name of the image. The name must be unique within a region. If you specify the ImageId parameter, the ImageName parameter is ignored.

You cannot use the ImageName parameter to specify Alibaba Cloud Marketplace images.

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

The number of vCPUs.

You can specify the number of vCPUs and the memory size to determine 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. Auto Scaling determines a set of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates ECS instances of the instance type that has the lowest unit price.

The memory size.

You can specify the number of vCPUs and the memory size to determine 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. Auto Scaling determines a set of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates ECS instances of the instance type that has the lowest unit price.

The ID of the deployment set to which the ECS instances belong.

The ID of the security group to which the ECS instances belong. The ECS instances that belong to the same security group can access each other.

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

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

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 traffic that you use. InternetMaxBandwidthOut specifies only the maximum available bandwidth.

Default value for the classic network: PayByBandwidth. Default value for VPCs: PayByTraffic.

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

Default value: 200. This parameter is not used for billing because inbound traffic of instances is free of charge.

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

• Valid values if you set InternetChargeType to PayByBandwidth: 0 to 100. If you leave this parameter empty, a value of 0 is used.
• Valid values if you set InternetChargeType to PayByTraffic: 0 to 100. If you leave this parameter empty, an error is reported.

The category of the system disk. Valid values:

• cloud: basic disk
• cloud_efficiency: ultra disk
• cloud_ssd: standard SSD
• ephemeral_ssd: local standard SSD
• cloud_essd: enhanced SSD (ESSD)

You cannot specify the SystemDisk.Category and SystemDiskCategories.N parameters at the same time. If you do not specify the SystemDisk.Category and SystemDiskCategories.N parameters, the default value of SystemDisk.Category is used. For non-I/O optimized instances of Generation I instance types, the default value is cloud. For instances of other types, the default value is cloud_efficiency.

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

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

Default value: max{40, ImageSize}.

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 (-).

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

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

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

• PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
• PL1: 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.

Default value: PL0.

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 within a scaling group in a region. If you do not specify this parameter, the value of ScalingConfigurationId is used.

The weight of the ECS instance as a backend server of the associated Server Load Balancer (SLB) instance. Valid values: 1 to 100.

Default value: 50.

The tags of the ECS instance. The tags must be specified in the key-value pair format. You can specify up to 20 tags. Take note of the following items when you specify tag keys and tag values:

• A tag key can be up to 64 characters in length. The key 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. The value cannot start with acs: or aliyun, and cannot contain http:// or https://. You can specify an empty string as a tag value.

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

The name of the key pair that is used to log on to an ECS instance.

• Windows instances do not use this parameter.
• By default, the username and password authentication method is disabled for Linux instances.

The name of the RAM role that is associated with the ECS instance. The name is provided and maintained by Resource Access Management (RAM). You can call the ListRoles operation to query the available RAM roles. For information about how to create a RAM role, see CreateRole.

Specifies whether to enable security hardening. Valid values:

• Active: enables security hardening. This value is available only for public images.
• Deactive: disables security hardening. This value is available for all image types.

The name of the ECS instance that is automatically created based on the scaling configuration.

The hostname of the ECS instance. The hostname cannot start or end with a period (.) or a hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-). Naming conventions for different types of instances:

• Windows instances: The hostname must be 2 to 15 characters in length, and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.). It cannot contain only digits.
• Other instances such as Linux instances: 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 (-).

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

• NoSpot: This policy applies to regular pay-as-you-go instances.
• SpotWithPriceLimit: This policy applies to preemptible instances for which a maximum hourly price is specified.
• SpotAsPriceGo: This policy applies to preemptible instances for which the market price at the time of purchase is used as the bid price.

Default value: NoSpot.

Specifies whether to use the password preset in the image. Before you use this parameter, make sure that a password is configured for the image. Valid values:

• true
• false

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

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

The password of a Windows instance cannot start with a forward slash (/).

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

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

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

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

The number of randomly generated IPv6 addresses that you want to allocate to the elastic network interface (ENI).

The performance mode of the burstable instance. Valid values:

• Standard: standard mode
• Unlimited: unlimited mode

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

The name of the image family. You can specify this parameter to obtain the latest custom images that are available in the specified image family. The images are used to create ECS instances. If you specify the ImageId parameter, you cannot specify the ImageFamily parameter.

The ID of the zone where the ECS instance resides.

The ID of the dedicated host on which you want to create the ECS instance. You cannot create preemptible instances on dedicated hosts. If you specify the DedicatedHostId parameter, the SpotStrategy and SpotPriceLimit parameters are ignored.

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

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 in economical mode when the original dedicated host of the instance has insufficient resources, the instance is 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 was in economical mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the instance fails to start.

Default value: 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 the DedicatedHostId parameter, the system selects a dedicated host for the instance that you created.

Default value: default.

The type of the private pool. A private pool is generated after an elasticity assurance or a capacity reservation takes effect. You can select a private pool when you create instances. 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 available, the resources in the public pool are used. In this case, you do not need to specify the PrivatePoolOptions.Id parameter.
• Target: specified private pool. The system uses the capacity of 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, you must specify the PrivatePoolOptions.Id parameter.
• None: no private pool. The capacity of private pools is not used.

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

The retention period of the preemptible instance. Unit: hours. Valid values: 0 to 6.

• The following retention 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 you set this parameter to 0, no retention period is specified for the preemptible instance.

Default value: 1.

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

Specifies whether to encrypt the system disk. Valid values:

• true
• false

Default value: false.

The ID of the Key Management Service (KMS) key that is used to encrypt the system disk.

The algorithm that is used to encrypt the system disk. Valid values:

• AES-256.
• SM4-128.

Default value: AES-256.

Instance type N of ECS instances. If you specify this parameter, the InstanceType parameter is ignored. You can specify up to 10 instance types for a scaling configuration. Valid values of N: 1 to 10.

A smaller value of N specifies a higher priority. Auto Scaling creates instances based on the priorities of the instance types. If Auto Scaling cannot create instances of the instance type that has the highest priority, it creates instances of the instance type that has the next highest priority.

If you want to specify the capacity of instance types in the scaling configuration, you must specify the InstanceTypeOverride.N.InstanceType and InstanceTypeOverride.N.WeightedCapacity parameters.

This parameter is used to specify the instance type. You can specify N values for this parameter. You can use this parameter together with the InstanceTypeOverride.N.WeightedCapacity parameter to specify weights for multiple instance types. Valid values of N: 1 to 10.

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

If you want to specify the capacity of instance types in the scaling configuration, you must specify the InstanceTypeOverride.N.InstanceType and InstanceTypeOverride.N.WeightedCapacity parameters. The two parameters have a one-to-one correspondence. The value of N in the two parameters must be the same.

This parameter specifies the weight of the instance type. The weight specifies the capacity of a single instance of the specified instance type in the scaling group. A higher weight specifies that a smaller number of instances of the specified instance type are required to meet 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 capacity: 6
• Capacity of ecs.c5.xlarge: 4

To meet the expected capacity, Auto Scaling creates two ecs.c5.xlarge instances.

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

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

• PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
• PL1: 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.

Default value: PL1.

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

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

• true
• false

Default value: false.

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

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, the DataDisk.N.Size parameter is ignored. The size of the 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 the system returns InvalidSnapshot.TooOld.

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 N: 1 to 16. The second N in DataDisk.N.Categories.N represents the serial number of the data disk category. Valid values of N: 1 to 4. You can specify up to four data disk categories in a scaling configuration. A smaller value of N specifies a higher priority. If Auto Scaling cannot create data disks of the disk category that has the highest priority, it creates disks of 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 the instance is set to true.
• cloud_efficiency: ultra disk.
• cloud_ssd: SSD.
• cloud_essd: ESSD.

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

• Valid values if you set DataDisk.N.Category to cloud: 5 to 2000.
• Valid values if you set DataDisk.N.Category to cloud_efficiency: 20 to 32768.
• Valid values if you set DataDisk.N.Category to cloud_ssd: 20 to 32768.
• Valid values if you set DataDisk.N.Category to cloud_essd: 20 to 32768 .
• Valid values if you set DataDisk.N.Category to ephemeral_ssd: 5 to 800.

The value of DataDisk.N.Size must be greater than or equal to the size of the snapshot that is specified by SnapshotId.

The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when you create the ECS instance. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.

The name of data disk N. Valid values of N: 1 to 16. 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 (-).

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

• cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with the instance is set to true.
• cloud_efficiency: ultra disk.
• cloud_ssd: standard SSD.
• ephemeral_ssd: local standard SSD.
• cloud_essd: ESSD.

You cannot specify the DataDisk.N.Category and DataDisk.N.Categories.N parameters at the same time. If you do not specify the DataDisk.N.Category and DataDisk.N.Categories.N parameters, the default value of DataDisk.N.Category is:

• cloud_efficiency for I/O optimized instances.
• cloud for non-I/O optimized instances.

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

• true: If the instance is released, the data disk is released.
• false: If the instance is released, the data disk is retained.

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

Default value: true.

The ID of the KMS key of data disk N. Valid values of N: 1 to 16.

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

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

The ID of security group N with which you want to associate the ECS instance. The valid values of N vary based on the maximum number of security groups with which an instance can be associated. For more information, see the "Security group limits" section in Limits.

The number of vCPUs that are specified for an instance type in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. For more information, see Instance families. Valid values of N: 1 to 10.

Take note of the following items:

• The InstancePatternInfo.N parameter is available only for scaling groups that reside in VPCs.
• You must specify the InstancePatternInfo.N, InstancePatternInfo.N.Cores, and InstancePatternInfo.N.Memory parameters at the same time.
• If you specify an instance type in the InstanceType or InstanceTypes.N parameter, Auto Scaling preferentially uses the instance type that is specified by the InstanceType or InstanceTypes.N parameter for scale-out activities. If insufficient instances of the specified instance type are available, Auto Scaling uses the instance types that are specified by the InstancePatternInfo.N parameter based on the unit price in ascending order.

The instance family level in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. Valid values:

• EntryLevel: shared instance type. Instances of this level are more cost-effective, but do not provide stable computing performance. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see Shared instance families.
• EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see Instance families.
• CreditEntryLevel: This value is available only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see What are burstable instances?

Valid values of N: 1 to 10.

The maximum hourly price for a pay-as-you-go instance or a preemptible instance in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. Valid values of N: 1 to 10.

The memory size that is specified for an instance type in intelligent configuration mode. Unit: GiB. This parameter is used to filter the available instance types that meet the specified criteria. For more information, see Instance families. Valid values of N: 1 to 10.

Category N of the system disk. Valid values of N: 1 to 4. You can specify up to four system disk categories in a scaling configuration. A smaller value of N specifies a higher priority. If Auto Scaling cannot create system disks of the disk category that has the highest priority, it creates disks of 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

The ID of the scaling configuration.

The ID of the request.