CreateScalingConfiguration

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

The ID of the image file used to automatic creation of instances.

The name of the image file. Image names are unique within a region. You cannot use this parameter to specify images from Alibaba Cloud Marketplace.

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

The number of vCPUs. Unit: cores.

Specifying both CPU and Memory defines the range of instance types. For example, CPU=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, and creates instances with the lowest price sorted by price.

The memory size. Unit: GiB.

Specifying both CPU and Memory defines the range of instance types. For example, CPU=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, and creates instances with the lowest price sorted by 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 access each other.

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

• none: non-I/O optimized instance.

• optimized: I/O optimized instance.

The default value for retired instance types is none. The default value for other instance types is optimized.

The billing method for network usage. Valid values:

• PayByBandwidth: pay-by-bandwidth. The value of InternetMaxBandwidthOut is the fixed bandwidth value.

• PayByTraffic: pay-by-traffic. The value of InternetMaxBandwidthOut is only a bandwidth upper limit. Billing is based on the actual network traffic.

If this parameter is not specified, the default value is PayByBandwidth for the 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 cloud disk. Valid values:

• cloud: basic cloud disk.

• cloud_efficiency: ultra cloud disk.

• cloud_ssd: standard SSD.

• ephemeral_ssd: local SSD.

• cloud_essd: ESSD.

• cloud_auto: ESSD AutoPL cloud disk.

This parameter cannot be specified together with SystemDiskCategories.N. If neither this parameter nor SystemDiskCategories.N is specified, this parameter has a default value. If the InstanceType is a Series I instance type and the instance is a non-I/O optimized instance, the default value is cloud. Otherwise, the default value is cloud_efficiency.

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

• Basic cloud disk: 20 to 500.

• ESSD:

  • PL0: 1 to 2048.

  • PL1: 20 to 2048.

  • PL2: 461 to 2048.

  • PL3: 1261 to 2048.

• ESSD AutoPL cloud disk: 1 to 2048.

• Other cloud disk types: 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 cloud 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 or a Chinese character and cannot start with http:// or https://.

The description of the system cloud 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 applied to the system cloud disk.

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

• PL0: a single cloud disk can deliver up to 10,000 random read/write IOPS.

• PL1: a single cloud disk can deliver up to 50,000 random read/write IOPS.

• PL2: a single cloud disk can deliver up to 100,000 random read/write IOPS.

• PL3: a single cloud disk 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 letters, digits, underscores (_), hyphens (-), and periods (.). It must start with a digit, letter, or Chinese character.

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

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

Default value: 50.

The tags of the ECS instance. Tags are specified as key-value pairs. You can specify up to 20 tags. The following limits apply to the Key and Value parameters:

• Key can be up to 64 characters in length and cannot start with aliyun or acs:, and cannot contain http:// or https://. Key cannot be an empty string when a tag is used.

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

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

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

• For Windows instances, this parameter is ignored and is empty by default.

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

The name of the RAM role associated with the ECS instance. The RAM role name is provided and maintained by RAM. You can call ListRoles to query available RAM roles. For more 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 applicable only to public images.

• Deactive: disables security hardening. This value is applicable to all image types.

The name of the ECS instance that is automatic creation by using this scaling configuration.

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

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

• Other instances (such as Linux): The hostname must be 2 to 64 characters in length and can contain multiple periods (.). Each segment separated by a period (.) can contain letters, digits, and hyphens (-).

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

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

• SpotWithPriceLimit: a spot instance with a user-defined maximum hourly price.

• SpotAsPriceGo: a spot instance priced at the market price at the time of purchase.

Default value: NoSpot.

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

• true: uses the password preset in the image.

• false: does not use the password preset in the image.

The password of the 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:

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

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 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 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 How to ensure idempotence.

The number of randomly generated IPv6 addresses allocated to the elastic network interfaces (ENIs).

The running mode of the burstable instance. Valid values:

• Standard: standard mode.

• Unlimited: unlimited mode.

For more information, see the performance mode 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 for instance creation. If the ImageId parameter is already set, you cannot set this parameter.

The zone ID of the ECS instance.

Specifies whether to create the ECS instance on a dedicated host. Because dedicated hosts do not support the creation of spot instances, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored when the DedicatedHostId parameter is specified.

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

Specifies whether the instance on a dedicated host is associated with the dedicated host. Valid values:

• default: the instance is not associated with the dedicated host. When an instance that has the economical mode enabled is restarted, the instance may be placed on another dedicated host in the automatic deployment resource pool if the original dedicated host has insufficient available resources.

• host: the instance is associated with the dedicated host. When an instance that has the economical mode enabled is restarted, the instance remains on the original dedicated host. If the original dedicated host has insufficient available resources, the instance fails to restart.

Default value: default.

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

• default: creates a non-dedicated host instance.

• host: creates a dedicated host instance. If you do not specify DedicatedHostId, Alibaba Cloud automatically selects a dedicated host for the instance.

Default value: default.

The scheduler options.

The private pool option for instance startup. A private pool is generated after an elasticity assurance or capacity reservation takes effect. You can select a private pool when you start an instance. Valid values:

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

• Target: specified mode. The instance is started by using the capacity of the specified private pool. If the specified private pool is unavailable, the instance fails to start. In this mode, you must specify the private pool ID. The PrivatePoolOptions.Id parameter is required.

• None: none mode. The instance does not use private pool capacity for startup.

The private pool ID, which is the ID of the elasticity assurance or capacity reservation.

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

• 1: After a spot instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After 1 hour, the system automatically compares the bid price with the marketplace price and checks the resource inventory to determine whether to retain or revoke the instance.

• 0: After a spot instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system automatically compares the bid price with the marketplace price and checks the resource inventory to determine whether to retain or revoke the instance.

Default value: 1.

The interruption mode of the spot instance. Currently, only Terminate (default) is supported, which directly releases the instance.

Specifies whether to encrypt the system cloud disk. Valid values:

• true: encrypts the system cloud disk.

• false: does not encrypt the system cloud disk.

Default value: false.

The ID of the KMS key used for the system cloud disk.

The encryption algorithm used for the system cloud disk. Valid values:

• AES-256.

• SM4-128.

Default value: AES-256.

The provisioned IOPS (Input/Output Operations Per Second) performance metrics for the system cloud disk.

Specifies whether to enable the Burst (performance burst) feature for the system cloud disk. Valid values:

• true: enables the feature.

• false: does not enable the feature.

For more information, see ESSD AutoPL cloud disks.

Specifies whether the ECS instance uses the ecs-user user for logon. For more information, see Manage the logon name of an ECS instance. Valid values:

• true: yes.

• false: no.

Default value: false.

The release protection property of the ECS instance. This property applies only to pay-as-you-go instances and specifies whether the instance can be directly released from the ECS console or by calling the DeleteInstance operation. Valid values:

• true: enables release protection, which prevents the instance from being directly released from the ECS console or by calling the API operation. This prevents instances scaled out by Auto Scaling from being accidentally deleted.

• false: disables release protection, which allows the instance to be directly released from the ECS console or by calling the API operation.

Default value: false.

The ID of the dedicated block storage cluster.

The maximum number of partitions in the dedicated block storage cluster. The value must be an integer 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 access channel.

• disabled: disables the access channel.

Default value: enabled.

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

• optional: does not forcefully use the mode.

• required: forcefully uses the mode. After this value is set, instance metadata cannot be accessed in normal mode.

Default value: optional.

Specifies whether a vSwitch from the VSwitchIds list must be selected for the secondary elastic network interface (ENI) when the VSwitchIds parameter is settings for the secondary network interface controller (NIC).

• Strict: strict mode. If no vSwitch in VSwitchIds meets the conditional requirements, instance creation fails.

• Tolerant: tolerant mode. If no vSwitch in VSwitchIds meets the conditional requirements, no secondary elastic network interface (ENI) is set, and the instance is still created as active.

Default value: Strict.