ModifyScalingConfiguration

The action to perform. Set the value to ModifyScalingConfiguration.

The ID of the scaling configuration to modify.

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

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

The bidding 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 spot instance for which you can specify a maximum hourly price.
• SpotAsPriceGo: The instance is a spot instance for which the system automatically bids at the current market price.

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

The name must be unique within its scaling group and region. If you omit this parameter, the scaling configuration ID is used as the name.

The name of ECS instances created by this scaling configuration.

The hostname of the ECS instance. The hostname cannot start or end with a period (.) or a hyphen (-), and cannot contain consecutive periods or hyphens. Naming conventions vary by operating system:

• Windows: The hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.) or be composed of only digits.
• Other OS (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 ID of the image used to create instances.

The name of the image. 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 number of vCPUs.

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 matched. Auto Scaling considers factors such as I/O optimization and availability zone to determine the available instance types and then creates an instance of the lowest-priced matching instance type.

The memory size in 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 matched. Auto Scaling considers factors such as I/O optimization and availability zone to determine the available instance types and then creates an instance of the lowest-priced matching instance type.

The network billing method. Valid values:

• PayByBandwidth: Bills by bandwidth. InternetMaxBandwidthOut specifies the fixed bandwidth.
• PayByTraffic: Bills by traffic. InternetMaxBandwidthOut specifies the maximum bandwidth, and billing is based on actual usage.

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 Cloud Disk.
• cloud_efficiency: Ultra Cloud Disk.
• cloud_ssd: SSD cloud disk.
• cloud_essd: ESSD.
• ephemeral_ssd: local SSD disk.
• cloud_auto: ESSD AutoPL disk.

You cannot specify this parameter and SystemDiskCategories.N at the same time. If neither this parameter nor SystemDiskCategories.N is specified, a default value is used. For non-I/O-optimized, first-generation instances, the default is cloud; otherwise, the default is cloud_efficiency.

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

• Basic Cloud Disk: 20 to 500.
• ESSD:
  • PL0: 1 to 2,048.
  • PL1: 20 to 2,048.
  • PL2: 461 to 2,048.
  • PL3: 1,261 to 2,048.
• ESSD AutoPL disk: 1 to 2,048.
• Other cloud disk types: 20 to 2,048.

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 long, 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 long and cannot start with http:// or https://.

The ID of the auto snapshot policy for the system disk.

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

• PL0: An ESSD at this level can deliver up to 10,000 random read/write IOPS.
• PL1: An ESSD at this level can deliver up to 50,000 random read/write IOPS.
• PL2: An ESSD at this level can deliver up to 100,000 random read/write IOPS.
• PL3: An ESSD at this level can deliver up to 1,000,000 random read/write IOPS.

The weight of the backend server. Valid values: 1 to 100.

The user data for the ECS instance. The data must be Base64-encoded, and the original data cannot exceed 32 KB.

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

• On Windows instances, this parameter is ignored.
• On Linux instances, setting this parameter disables password-based logon by default.

The name of the RAM role for the ECS instance. You can call the ListRoles operation to query available RAM roles. To create a RAM role, call the CreateRole operation.

Specifies whether to use the password preset in the image. If you enable this, ensure the image has a preset password.

The tags of the ECS instance. Tags are specified as key-value pairs. You can specify up to 20 tags. The key and value must meet the following requirements:

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

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 within the same security group can access each other.

Specifies whether to overwrite the existing configurations. Valid values:

• true: Overwrites the existing configurations.
• false: Does not overwrite the existing configurations.

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

The number of randomly generated IPv6 addresses to assign to the elastic network interface.

The performance mode of the burstable performance instance. Valid values:

• Standard: the standard mode. For more information about the performance of the instance, see the "Performance-constrained mode" section in What is a burstable performance instance?
• Unlimited: the unlimited mode. For more information about the performance of the instance, see the "Unlimited mode" section in What is a burstable performance instance?

You can set this parameter to use the latest available image from the specified image family to create instances. This parameter cannot be specified if ImageId is also set.

The ID of the availability zone in which the ECS instance resides.

The ID of the dedicated host on which to launch the ECS instance. If you specify a DedicatedHostId, the instance will not be a spot instance, and any SpotStrategy or SpotPriceLimit settings are ignored.

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

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

• default: The instance is not associated with a specific dedicated host. When restarting a stopped instance, it may be moved to a different host if the original host lacks resources.
• host: The instance is associated with a specific dedicated host. When restarting a stopped instance, it remains on the original host. The restart fails if the original host lacks resources.

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

• default: The instance runs on shared hardware.
• host: The instance runs on a dedicated host. If you do not specify DedicatedHostId, one is automatically selected for you.

The scheduling options.

An elasticity assurance or capacity reservation generates a private pool of resources. This parameter defines how to use that pool when launching instances. Valid values:

• Open: open mode. The system automatically matches the capacity of open private pools. If no eligible private pool is found, public pool resources are used. In this mode, you do not need to specify the PrivatePoolOptions.Id parameter.
• Target: specified mode. The instance is launched by using the capacity of a specified private pool. If the specified private pool is unavailable, the instance launch fails. In this mode, you must specify a private pool ID in the PrivatePoolOptions.Id parameter.
• None: no mode. The instance does not use private pool capacity.

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

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

• 1: Alibaba Cloud ensures that the instance is not automatically released within 1 hour of its creation. After the 1-hour period, 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: Alibaba Cloud does not guarantee that the instance runs for 1 hour after creation. 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 action to take when a spot instance is interrupted. Only Terminate (release the instance) is supported. This is the default.

The performance level of the ESSD that is used as a data disk. The value of N must be the same as the value of N in DataDisk.N.Category=cloud_essd. Valid values:

• PL0: An ESSD at this level can deliver up to 10,000 random read/write IOPS.
• PL1: An ESSD at this level can deliver up to 50,000 random read/write IOPS.
• PL2: An ESSD at this level can deliver up to 100,000 random read/write IOPS.
• PL3: An ESSD at this level can deliver up to 1,000,000 random read/write IOPS.

The ID of the auto snapshot policy applied to data disk N. The value of N can be 1 to 16.

Specifies whether to encrypt data disk N. The value of N can be 1 to 16. Valid values:

• true: encrypts the disk.
• false: does not encrypt the disk.

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

The snapshot that is used to create data disk N. The value of N can be 1 to 16. If you specify this parameter, DataDisk.N.Size is ignored, and the size of the created disk is the size of the specified snapshot.

Snapshots created on or before July 15, 2013, are not supported and will result in an InvalidSnapshot.TooOld error.

A prioritized list of categories for data disk N. The first N identifies the data disk (1-16), and the second N sets the priority (1-4). You can specify up to four categories. Auto Scaling attempts to create the disk using the highest-priority category first, falling back to lower-priority categories if the attempt fails. Valid values:

• cloud: Basic Cloud Disk. The DeleteWithInstance attribute of a Basic Cloud Disk that is created with an instance is true.
• cloud_efficiency: Ultra Cloud Disk.
• cloud_ssd: SSD cloud disk.
• cloud_essd: ESSD.

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

• cloud: 5 to 2,000.
• cloud_efficiency: 20 to 32,768.
• cloud_essd: 20 to 32,768.
• ephemeral_ssd: 5 to 800.

If you specify this parameter, the disk size must be greater than or equal to the snapshot size specified by SnapshotId.

The mount point of data disk N. The value of N can be 1 to 16. If you do not specify this parameter, the system allocates a mount point when it automatically creates an ECS instance. The mount points range from /dev/xvdb to /dev/xvdz.

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

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

• cloud: Basic Cloud Disk. The DeleteWithInstance attribute of a Basic Cloud Disk that is created with an instance is true.
• cloud_efficiency: Ultra Cloud Disk.
• cloud_ssd: SSD cloud disk.
• cloud_essd: ESSD.
• ephemeral_ssd: local SSD disk.
• cloud_auto: ESSD AutoPL disk.

You cannot specify this parameter and DataDisk.N.Categories.N at the same time. If neither this parameter nor DataDisk.N.Categories.N is specified, the default value is determined as follows:

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

Specifies whether to release data disk N when the instance is released. The value of N can be 1 to 16. Valid values:

• true: The disk is released when the instance is released.
• false: The disk is not released when the instance is released.

You can set this parameter only for cloud disks (DataDisk.N.Category is set to cloud, cloud_efficiency, cloud_ssd, or cloud_essd). Otherwise, an error is returned.

The ID of the KMS key for data disk N. The value of N can be 1 to 16.

The IOPS provisioned for the data disk.

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

• true: enables the feature.

• false: disables the feature.

  Note This parameter is supported only when DataDisk.Category is set to cloud_auto.

The bid price for the spot instance. The value of N can be 1 to 20. This parameter is effective only when SpotStrategy is set to SpotWithPriceLimit.

The instance type of the spot instance. The value of N can be 1 to 20. This parameter is effective only when SpotStrategy is set to SpotWithPriceLimit.

The parameter for multiple instance types. If you specify InstanceTypes.N, InstanceType is ignored. The value of N can be 1 to 20, which means that you can specify up to 20 instance types in a scaling configuration.

N defines the priority, where 1 is the highest. If instance creation fails for a higher-priority type, Auto Scaling automatically attempts to use the next type in the list.

If you need to specify the capacity of an instance type in a scaling configuration, specify both this parameter and InstanceTypeOverride.N.WeightedCapacity.

This parameter specifies the instance type. You can specify N instances of this parameter, in conjunction with the InstanceTypeOverride.N.WeightedCapacity parameter, to extend multi-instance type support with custom weights. The value of N can be 1 to 20.

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

If you need to specify the capacity of an instance type in the scaling configuration, specify this parameter after specifying InstanceTypeOverride.N.InstanceType. These two parameters are paired, and the value of N must be the same.

This parameter specifies the weight of the instance type. The weight represents the capacity of a single instance of that type in the scaling group. A higher weight means that fewer instances of this type are needed to meet the desired capacity.

You can configure different weights for different instance types based on your needs, as performance metrics such as the number of vCPUs and memory size may vary.

Example:

• Current capacity: 0
• Desired capacity: 6
• Capacity of an ecs.c5.xlarge instance: 4

To meet the desired capacity, the scaling group will scale out two ecs.c5.xlarge instances.

Valid values for WeightedCapacity: 1 to 500.

The ID of the security group.

In intelligent configuration mode, this parameter specifies the number of vCPU cores of the instance type, which is used to filter instance types. For more information, see Instance families. The value of N can be 1 to 10.

Take note of the following information:

• The InstancePatternInfo.N parameter is applicable only when the network type of the scaling group is a virtual private cloud (VPC).
• When you specify InstancePatternInfo.N, you must also specify both InstancePatternInfo.N.Cores and InstancePatternInfo.N.Memory.
• If InstanceType or InstanceTypes.N is specified, those types are prioritized. If they are unavailable, Auto Scaling selects the lowest-priced instance type that matches the InstancePatternInfo filters.

In intelligent configuration mode, this parameter specifies the level of the instance family, which is used to filter instance types. Valid values:

• EntryLevel: entry-level instances, which are shared instance types. These instances offer lower costs but cannot guarantee stable computing performance. They are suitable for business scenarios with low CPU utilization. For more information, see Shared instance families.
• EnterpriseLevel: enterprise-level instances. These instances offer stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see Instance families.
• CreditEntryLevel: credit entry-level instances, which are burstable performance instances. These instances use CPU credits to ensure computing performance and are suitable for scenarios with low average CPU utilization but occasional CPU usage spikes. For more information, see Burstable performance instances.

The value of N can be 1 to 10.

In intelligent configuration mode, this parameter specifies the maximum acceptable hourly price for pay-as-you-go or spot instances, which is used to filter instance types. The value of N can be 1 to 10.

In intelligent configuration mode, this parameter specifies the memory size of the instance type. Unit: GiB. This parameter is used to filter instance types. For more information, see Instance families. The value of N can be 1 to 10.

The architecture type of the instance type. Valid values:

• X86: x86 architecture.
• Heterogeneous: heterogeneous computing architecture, such as GPU or FPGA.
• BareMental: ECS bare metal instance.
• Arm: Arm architecture.

Default value: All architecture types are included.

Specifies whether to include burstable performance instances. Valid values:

• Exclude: does not include burstable performance instances.
• Include: includes burstable performance instances.
• Required: includes only burstable performance instances.

Default value: Include.

The instance types to exclude. You can use wildcards (*) to exclude a single instance type or an entire instance family. Examples:

• ecs.c6.large: excludes the ecs.c6.large instance type.
• ecs.c6.*: excludes all instance types of the c6 family.

The specified instance families. N indicates that you can specify multiple instance families, with a value range of 1 to 10.

The minimum number of vCPU cores for the instance type.

The maximum number of vCPU cores for the instance type.

The specified GPU type.

The category of the instance type.

• 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
• High-performance compute

The CPU architecture of the instance. Valid values:

• X86
• ARM

The processor model of the instance. N indicates that you can specify multiple processor models, with a value range of 1 to 10.

The minimum number of elastic network interfaces that the instance must support.

The minimum number of IPv4 addresses per elastic network interface that the instance must support.

The minimum number of IPv6 addresses per elastic network interface that the instance must support.

The minimum initial vCPU credits for burstable performance instances of the t5 or t6 family.

The minimum baseline vCPU computing performance (sum of all vCPUs) for burstable performance instances of the t5 or t6 family.

The minimum memory size for the instance. Unit: GiB.

The maximum memory size for the instance. Unit: GiB.

The minimum number of GPUs required for the instance. The value must be a positive integer greater than or equal to 1.

The maximum number of GPUs required for the instance. The value must be a positive integer greater than or equal to 1.

The categories for the system disk. The value of N can be 1 to 4, which means that you can specify up to four disk categories for a system disk in a scaling configuration. A smaller N value indicates a higher priority. If a system disk cannot be created by using a disk category with a higher priority, Auto Scaling automatically tries the next disk category. Valid values:

• cloud: Basic Cloud Disk.
• cloud_efficiency: Ultra Cloud Disk.
• cloud_ssd: SSD cloud disk.
• cloud_essd: ESSD.

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. The supported special characters are:

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 used for the system disk.

The encryption algorithm for the system disk. Valid values:

• AES-256
• SM4-128

Default value: AES-256.

The IOPS provisioned for 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.

  Note This parameter is supported only when SystemDisk.Category is set to cloud_auto.

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

The deletion protection setting for the ECS instance. This parameter applies only to pay-as-you-go instances and specifies whether an instance is protected from accidental deletion via the ECS console or the DeleteInstance API call. Valid values:

• true: Enables release protection. This prevents the instance from being released directly from the ECS console or by using the API, which helps prevent accidental deletion of instances that are scaled out by Auto Scaling.
• false: Disables release protection. This allows the instance to be released directly from the ECS console or by using the API.

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 CustomPriorities field specifies the custom priority of an ECS instance type and vSwitch combination. The CustomPriorities.N.InstanceType parameter specifies the instance type in the custom priority.

If an ECS instance cannot be created from a higher-priority ECS instance type and vSwitch combination, Auto Scaling automatically selects the next-priority ECS instance type and vSwitch combination to create the instance.

The CustomPriorities.N.VswitchId parameter specifies the ID of the vSwitch in the custom priority.

The elastic network interface type. If you use this parameter, you must use NetworkInterfaces.N to configure the primary network interface. You cannot specify SecurityGroupId or SecurityGroupIds.N at the same time. Valid values:

• Primary: primary network interface.
• Secondary: secondary network interface.

Default value: Secondary.

The communication mode of the network interface. Valid values:

• Standard: uses TCP communication mode.
• HighPerformance: enables the Elastic RDMA Interface (ERI) and uses RDMA communication mode.

Default value: Standard.

The number of randomly generated IPv6 addresses to assign to the primary network interface. Note the following:

• This parameter is effective only when NetworkInterfaces.N.InstanceType is set to Primary.
• You cannot set this parameter if NetworkInterfaces.N.InstanceType is set to Secondary or is empty.
• If you set this parameter, you cannot set the Ipv6AddressCount parameter.

The IDs of one or more security groups to which the elastic network interface belongs. Note the following:

• If NetworkInterfaces.N.InstanceType is set to Primary, you must set this parameter. It serves the same purpose as SecurityGroupIds.N, but you cannot set SecurityGroupId or SecurityGroupIds.N at the same time.
• If NetworkInterfaces.N.InstanceType is set to Secondary or is empty, this parameter is optional. The default value is the security group of the ECS instance, which is the security group of the primary network interface.

The number of secondary private IPv4 addresses to assign to the network interface. Valid values: 1 to 49.

• The value cannot exceed the IP address limit for the instance type. For more information, see Instance families.
• NetworkInterface.N.SecondaryPrivateIpAddressCount is used to assign a number of secondary private IPv4 addresses (excluding the primary private IP address of the network interface). The system randomly assigns these addresses from the available CIDR block of the vSwitch where the network interface is located (NetworkInterface.N.VSwitchId).

The ID of the dedicated host cluster.

The confidential computing mode. Valid values:

• Enclave: The ECS instance uses an enclave to build a confidential computing environment. For more information, see Build a confidential computing environment by using an enclave.
• TDX: builds a TDX confidential computing environment. For more information, see Build a TDX confidential computing environment.

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

• enabled
• disabled

Default value: enabled.

Specifies whether to enforce the use of Instance Metadata Service Version 2 (IMDSv2) when accessing instance metadata. Valid values:

• optional: does not enforce the use of IMDSv2.
• required: enforces the use of IMDSv2. If you set this value, you cannot access instance metadata in normal mode.

Default value: optional.

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. The default value is 10.
• If the purchased outbound public bandwidth is greater than 10 Mbit/s: 1 to the value of InternetMaxBandwidthOut. The default value is the value of InternetMaxBandwidthOut.

A resource pool includes private pools generated after elasticity assurances or capacity reservations take effect, as well as public pools, for launching instances. Valid values:

• PrivatePoolFirst: Private pool first. If you select this policy, the system prioritizes using the corresponding private pool when ResourcePoolOptions.PrivatePoolIds is specified or when the conditions for PrivatePoolTags are met. If no private pool is specified or the specified private pool has insufficient capacity, the system automatically matches an open private pool. If no matching private pool is found, a public pool is used to create the instance.
• PrivatePoolOnly: Private pool only. If you select this policy, you must specify ResourcePoolOptions.PrivatePoolIds. If the specified private pool has insufficient capacity, the instance fails to be launched.

• PublicPoolFirst: Public pool first. The system prioritizes using a public pool to create the instance. If the public pool has insufficient resources, private pool resources are used as a supplement. The system prioritizes automatically matching an open private pool. If no matching private pool is found, a Target-type private pool that is specified by ResourcePoolOptions.PrivatePoolIds or that meets the PrivatePoolTags conditions is used.

  Note This policy is in invited preview and is not supported.

• None: No resource pool policy is used.

Default value: None.

The private pool ID, which is the ID of the elasticity assurance or capacity reservation. You can specify only the IDs of private pools in Target mode for this parameter. You cannot specify this parameter and the PrivatePoolTags parameter at the same time. The value of N can be 1 to 20.

The tag key of the private pool.

Filters available Target private pools based on tags. The value of N can be 1 to 20.

Notes:

• When this parameter is configured, the system filters only from the

  Target private pools associated with the account that have matching tags and also meet the constraints of the scaling group (such as availability zone and instance type).

• Tag matching rule: The private pool must match all specified tags.
• You cannot specify this parameter and the PrivatePoolIds parameter at the same time.

The tag value of the private pool.

The request ID.