Auto Scaling:CreateScalingConfiguration

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

The ID of the image that Auto Scaling uses to automatically create ECS instances.

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

You cannot use ImageName to specify images that are purchased from Alibaba Cloud Marketplace.

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

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. 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 by using the lowest-priced instance type.

The memory size. Unit: GiB.

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. 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 by using the lowest-priced instance type.

The ID of the deployment set of the ECS instances that are created by using the scaling configuration.

The ID of the security group with which ECS instances are associated. ECS instances that are associated with the same security group can access each other.

Specifies whether to create an I/O optimized instance. Valid values:

none: does not create an I/O optimized instance. optimized: creates 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.

The metering method for network usage. Valid values:

• PayByBandwidth: You are charged for the maximum available bandwidth that is specified by InternetMaxBandwidthOut.
• PayByTraffic: You are charged based on the amount of transferred data. InternetMaxBandwidthOut specifies only the maximum available bandwidth.

For the classic network, the default value is PayByBandwidth. For VPCs, the default value is 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 to instances is free of charge.

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

• Valid values if you set InternetChargeType to PayByBandwidth: 0 to 100. If you leave this parameter empty, this parameter is automatically set to 0.
• Valid values if you set InternetChargeType to PayByTraffic: 0 to 100. If you leave this parameter empty, an error is returned.

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: enhanced SSD (ESSD)
• cloud_auto: ESSD AutoPL disk

If you specify SystemDisk.Category, you cannot specify SystemDiskCategories. If you do not specify SystemDisk.Category or SystemDiskCategories, the default value of SystemDisk.Category is used.

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

The size of the system disk. Unit: GiB.

• If you set SystemDisk.Category 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 cloud_essd: 20 to 500.

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.

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

The description of the system disk. The description must be 2 to 256 characters in length. The description can contain letters 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 (PL) of the system disk that is an enhanced SSD (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.

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 do not specify this parameter, the scaling configuration ID is used.

The weight of an ECS instance as a backend server. Valid values: 1 to 100.

Default value: 50

The tags of the ECS instance. Tags must be specified as key-value pairs. You can specify up to 20 tags. 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. 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 data before encoding is 16 KB.

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

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

The name of the RAM role that you attach to 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.

Specifies whether to enable security hardening. Valid values:

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

The name of the ECS instance that Auto Scaling creates 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 (.) or 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 and preemptible instances. Valid values:

• NoSpot: The instance is created as a pay-as-you-go instance.
• SpotWithPriceLimit: The instance is a preemptible instance that has a user-defined maximum hourly price.
• SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.

Default value: NoSpot

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

• true
• false

The password that you want to use to log on to an ECS instance. The 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 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 instances that are created by using the scaling configuration belong.

The ID of the Elastic High Performance Computing (E-HPC) cluster to which the ECS instances that are created by using the scaling configuration belong.

The description of the ECS instance. The description must be 2 to 256 characters in length. The description can contain letters 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 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 the "How to ensure the idempotence of a request" topic.

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 the " Overview " topic.

The name of the image family. If you specify this parameter, the most recent custom images that are available in the specified image family are returned. You can use the images to create instances. If you specify ImageId, you cannot specify ImageFamily.

The zone ID of the ECS instance.

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

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

Specifies whether to associate an 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 start an ECS instance that was stopped in economical mode and the original dedicated host has insufficient resources, the ECS 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 start an ECS instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the ECS instance fails to start.

Default value: default

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

• default: does not create an ECS instance on a dedicated host.
• host: creates an ECS instance on a dedicated host. If you do not specify DedicatedHostId, Alibaba Cloud selects a dedicated host for the ECS instance.

Default value: default

The scheduler options.

The type of the 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 create ECS instances. Valid values:

• Open: open private pool. Auto Scaling selects a matching open private pool to start instances. If no matching open private pools are found, Auto Scaling uses the resources in the public pool to start instances. In this case, you do not need to specify PrivatePoolOptions.Id.
• Target: specified private pool. Auto Scaling uses the resources in the specified private pool to start ECS instances. If the specified private pool is unavailable, Auto Scaling cannot start ECS instances. 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.

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.

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

• The following retention periods are available 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 protection period is specified for the preemptible instance.

Default value: 1

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

The instance types. If you specify InstanceTypes, InstanceType is ignored.

Auto Scaling creates instances based on the priorities of the instance types. If Auto Scaling cannot create instances by using the instance type that has the highest priority, Auto Scaling creates instances by using the instance type that has the next highest priority.

The instance types.

The data disks.

The billing information of the preemptible instances.

The IDs of the security groups with which you want to associate the ECS instances that are created by using the scaling configuration. For more information, see the "Security group limits" section of the " Limits " topic.

Details of the intelligent configuration settings that determine the range of instance types that meet the specified criteria.

The categories of the system disks. If Auto Scaling cannot create instances by using the disk category that has the highest priority, Auto Scaling creates instances 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

Specifies whether to encrypt the system disk. Valid values:

• true
• false

Default value: false

The ID of the KMS key that you want to use to encrypt the system disk.

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

• AES-256
• SM4-128

Default value: AES-256

The IOPS metric that is preconfigured for the system disk.

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

• true
• false

For more information about whether an ECS instance uses the ecs-user user user to log on to an ECS instance, see Manage the login name of an ECS instance. Value range:

• true: Yes.
• false: No.

Default value: false.

The priority of the custom ECS instance type + vSwitch combination.

If Auto Scaling cannot create ECS instances by using the custom ECS instance type + vSwitch combination of the highest priority, Auto Scaling creates ECS instances by using the custom ECS instance type + vSwitch combination of the next highest priority.

• Example: the specified order of vSwitches for your scaling group is vsw1 and vsw2 and the specified order of instance types in your scaling configuration is type1 and type 2. In addition, you use CustomPriorities to specify ["vsw2+type2", "vsw1+type2"]. In this example, the vsw2+type2 combination has the highest priority and the vsw2+type1 combination has the lowest priority. The vsw1+type2 combination has a higher priority than the vsw1+type1 combination.