CreateScalingConfiguration

The ID of the scaling group to which the scaling configuration belongs.

The ID of the image file to use for creating instances.

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

You cannot use ImageName to specify a Marketplace image.

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

The number of vCPUs. Unit: cores.

You can specify both Cpu and Memory to define a range of instance types. For example, if you set Cpu to 2 and Memory to 16, all instance types with 2 vCPUs and 16 GiB of memory are selected. Auto Scaling determines the available instance types based on factors such as I/O optimization and zone, and then creates an instance of the instance type that has the lowest price.

The memory size. Unit: GiB.

You can specify both Cpu and Memory to define a range of instance types. For example, if you set Cpu to 2 and Memory to 16, all instance types with 2 vCPUs and 16 GiB of memory are selected. Auto Scaling determines the available instance types based on factors such as I/O optimization and zone, and then creates an instance of the instance type that has the lowest price.

The ID of the deployment set to which the ECS instance belongs.

The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can communicate with each other.

Specifies whether the instance is I/O optimized. Valid values:

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

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

The billing method for network usage. Valid values:

• PayByBandwidth: pay-by-bandwidth. InternetMaxBandwidthOut specifies the fixed bandwidth.

• PayByTraffic: pay-by-data-transfer. InternetMaxBandwidthOut specifies the maximum bandwidth. You are charged for the actual data transfer.

If you do not specify this parameter, the default value is PayByBandwidth for classic network and PayByTraffic for VPC.

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

• If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s: 1 to 10. Default value: 10.

• If the purchased outbound public bandwidth is greater than 10 Mbit/s: 1 to the value of InternetMaxBandwidthOut. Default value: the value of InternetMaxBandwidthOut.

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

Default value: 0.

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: ESSD.

• cloud_auto: ESSD AutoPL disk.

You cannot specify this parameter and SystemDiskCategories at the same time. If you do not specify this parameter or SystemDiskCategories, the default value of this parameter 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. Valid values:

• Basic disk: 20 to 500.

• ESSD:

  • PL0: 1 to 2048.

  • PL1: 20 to 2048.

  • PL2: 461 to 2048.

  • PL3: 1261 to 2048.

• ESSD AutoPL disk: 1 to 2048.

• Other disk categories: 20 to 2048.

The value of this parameter must be greater than or equal to max{1, ImageSize}.

Default value: max{40, ImageSize}.

The name of the system disk. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. It can contain 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 to apply to the system disk.

The performance level of the ESSD that is used as the system disk. 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 name of the scaling configuration. The name must be 2 to 64 characters in length, and can contain digits, underscores (_), hyphens (-), and periods (.). It must start with a digit, a letter, or a Chinese character.

The name of a scaling configuration must be unique within a scaling group in a region. If you do not specify this parameter, the ID of the scaling configuration is used.

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

Default value: 50.

The tags of the ECS instance. You can specify up to 20 tags in key-value pairs. The following limits apply to keys and values:

• A key can be up to 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://. If you use tags, the key cannot be an empty string.

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

The custom data of the ECS instance. The data must be Base64 encoded. The raw data can be up to 32 KB in size.

The name of the key pair to use to log on to the ECS instance.

• For Windows instances, this parameter is ignored. The default value is empty.

• For Linux instances, password-based logon is disabled.

The name of the RAM role for the ECS instance. The name is provided and maintained by 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 setting is valid only for public images.

• Deactive: disables security hardening. This setting is valid for all image types.

The name of the ECS instances that are created using the scaling configuration.

The hostname of the ECS instance. A period (.) or a hyphen (-) cannot be used as the first or last character of a hostname. Consecutive periods (.) or hyphens (-) are not allowed. The naming conventions for different instance types are as follows:

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

• For other instance types, such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

The preemption policy for pay-as-you-go instances. Valid values:

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

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

• SpotAsPriceGo: The instance is a preemptible instance for which the price is automatically bid based on the current market price.

Default value: NoSpot.

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

• true: uses the preset password.

• false: does not use the preset password.

The password of 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. Special characters can be:

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

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

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

The ID of the High Performance Computing (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://.

Ensures the idempotence of the request. You can use the client to generate a unique parameter value to make sure that the same request is not repeated. 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 to assign to the 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 of burstable instances.

The name of the image family. You can set this parameter to obtain the latest available image from the specified image family to create the instance. If you have specified the ImageId parameter, you cannot set this parameter.

The ID of the zone to which the ECS instance belongs.

Specifies whether to create the ECS instance on a dedicated host. If you specify the DedicatedHostId parameter, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored. This is because dedicated hosts do not support creating preemptible instances.

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

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

• default: The instance is not associated with the dedicated host. When you restart an instance that was stopped in economical mode, the instance may be placed on a different dedicated host in the automatic deployment resource pool if the original dedicated host has insufficient resources.

• host: The instance is associated with the dedicated host. When you restart an instance that was stopped in economical mode, the instance is still placed on the original dedicated host. If the original dedicated host has insufficient resources, the instance fails to restart.

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 DedicatedHostId, Alibaba Cloud automatically selects a dedicated host for the instance.

Default value: default.

The scheduling options.

The private pool capacity option for instance startup. After an Elastic Assurance or a Capacity Reservation service takes effect, a private pool is generated. You can select a private pool to start an instance. Valid values:

• Open: open mode. The system automatically matches the instance with an open private pool. If no eligible private pool is found, the instance is started using public pool resources. You do not need to set the PrivatePoolOptions.Id parameter in this mode.

• Target: specified mode. The instance is started using the capacity of a specified private pool. If the specified private pool is unavailable, the instance fails to start. You must set the PrivatePoolOptions.Id parameter in this mode.

• None: no private pool is used. The instance is started without using a private pool.

The ID of the private pool. This is the ID of the Elastic Assurance or Capacity Reservation service.

The protection period of the preemptible instance. Unit: hours. Valid values:

• 1: The instance is retained for 1 hour after it is created. After 1 hour, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.

• 0: The instance is not guaranteed to be retained for 1 hour after it is created. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.

Default value: 1.

The interruption mode of the preemptible instance. Currently, only terminate is supported, which releases the instance by default.

Specifies whether to encrypt the system disk. Valid values:

• true: encrypts the disk.

• false: does not encrypt the disk.

Default value: false.

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

The encryption algorithm for the system disk. Valid values:

• AES-256.

• SM4-128.

Default value: AES-256.

The provisioned IOPS of the system disk.

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

• true: enables the feature.

• false: disables the feature.

For more information, see ESSD AutoPL disks.

Specifies whether to use the ecs-user user to log on to the ECS instance. For more information, see Manage logon usernames of ECS instances. Valid values:

• true: Yes.

• false: No.

Default value: false.

The release protection attribute of the instance. This specifies whether you can release the instance through the ECS console or by calling the DeleteInstance API. This prevents accidental release of the instance. Valid values:

• true: enables release protection. You cannot release the instance through the ECS console or by calling the DeleteInstance API.

• false: disables release protection. You can release the instance through the ECS console or by calling the DeleteInstance API.

Default value: false.

The ID of the storage set.

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

The ID of the dedicated host cluster.

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

• enabled: enables the channel.

• disabled: disables the channel.

Default value: enabled.

Specifies whether to enforce the security-hardened mode (IMDSv2) when accessing instance metadata. Valid values:

• optional: does not enforce the mode.

• required: enforces the mode. If you set this value, you cannot access instance metadata in normal mode.

Default value: optional.