Auto Scaling:ModifyScalingGroup

The ID of the scaling group that you want to modify.

The name of the scaling group. The name must be unique within a region. The name must be 2 to 64 characters in length and can contain digits, uppercase letters, lowercase letters, Chinese characters, underscores (_), hyphens (-), and periods (.). It must start with a digit, letter, or Chinese character.

The minimum number of ECS instances or elastic container instances in the scaling group. When the number of ECS or elastic container instances in the scaling group is less than the MinSize value, Auto Scaling performs automatic creation of ECS instances or elastic container instances.

The maximum number of ECS instances or elastic container instances in the scaling group. When the number of ECS or elastic container instances in the scaling group exceeds the MaxSize value, Auto Scaling automatically removes instances.

The valid values of MaxSize depend on your Auto Scaling usage. Go to Quota Center to check the quota for Maximum number of instances in a scaling group.

For example, if the quota for Maximum number of instances in a scaling group is 2000, the valid values of MaxSize are 0 to 2000.

The cooldown time after a scaling activity (adding or removing ECS instances or elastic container instances) is complete. Valid values: 0 to 86400. Unit: seconds.

During the cooldown time, the scaling group does not execute other scaling activities. This parameter applies only to scaling activities triggered by CloudMonitor event-triggered tasks.

The first-priority scale-in policy for removing ECS instances from the scaling group. Valid values:

• OldestInstance: removes the ECS instance that was earliest added to the scaling group.

• NewestInstance: removes the ECS instance that was most recently added to the scaling group.

• OldestScalingConfiguration: removes the ECS instance that was created based on the earliest scaling configuration.

• CustomPolicy: removes ECS instances based on a custom scale-in policy (Function).

The second-priority scale-in policy for removing ECS instances from the scaling group. Valid values:

• OldestInstance: removes the ECS instance that was earliest added to the scaling group.

• NewestInstance: removes the ECS instance that was most recently added to the scaling group.

• OldestScalingConfiguration: removes the ECS instance that was created based on the earliest scaling configuration.

The third-priority scale-in policy for removing ECS instances from the scaling group. Valid values:

• OldestInstance: removes the ECS instance that was earliest added to the scaling group.

• NewestInstance: removes the ECS instance that was most recently added to the scaling group.

• OldestScalingConfiguration: removes the ECS instance that was created based on the earliest scaling configuration.

The ID of the active scaling configuration in the scaling group.

The health check mode of the scaling group. Valid values:

• NONE: Health checks are disabled.

• ECS: Health checks are performed on instances in the scaling group. This value applies to both ECS-type and ECI-type scaling groups.

• LOAD_BALANCER: The health check status of instances is determined based on load balancing health check results. Classic Load Balancer (CLB) is not supported.

Default value: ECS.

The ID of the launch template from which the scaling group obtains launch configuration information.

The version of the launch template. Valid values:

• A fixed template version number.

• Default: always uses the default version of the template.

• Latest: always uses the latest version of the template.

The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. When the number of pay-as-you-go instances is less than this value, pay-as-you-go instances are preferentially created.

When the MultiAZPolicy parameter is set to COMPOSABLE, the default value is 0.

The percentage of pay-as-you-go instances among the excess instances after the minimum number of pay-as-you-go instances (OnDemandBaseCapacity) is met. Valid values: 0 to 100.

When the MultiAZPolicy parameter is set to COMPOSABLE, the default value is 100.

Specifies whether to supplement spot instances. When this feature is enabled and the scaling group receives a system message that a spot instance is about to be reclaimed, the scaling group attempts to create a new instance to replace the spot instance that is about to be reclaimed.

Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances when spot instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect only when the MultiAZPolicy parameter of the CreateScalingGroup operation is set to COST_OPTIMIZED. Valid values:

• true: Pay-as-you-go instances are allowed.

• false: Pay-as-you-go instances are not allowed.

The number of available instance types. The scaling group creates spot instances of multiple types at the lowest cost. Valid values: 0 to 10.

When the MultiAZPolicy parameter is set to COMPOSABLE, the default value is 2.

The expected number of ECS instances or elastic container instances in the scaling group. Setting this parameter enables the expected number of instances feature. The scaling group automatically maintains the number of ECS or elastic container instances at the expected number. Valid values: MinSize ≤ DesiredCapacity ≤ MaxSize.

Specifies whether to enable deletion protection for the scaling group. Valid values:

• true: Deletion protection is enabled. The scaling group cannot be deleted.

• false: Deletion protection is disabled.

The scaling policy for ECS instances in a multi-zone scaling group. Valid values:

• PRIORITY: Instances are scaled based on the priority of the vSwitches (VSwitchIds.N). Auto Scaling preferentially attempts to scale instances in the zone of the highest-priority vSwitch. If the scaling fails, Auto Scaling attempts to scale instances in the zone of the next highest-priority vSwitch.

• COST_OPTIMIZED: During scale-out, Auto Scaling attempts to create ECS instances in ascending order of vCPU unit price. During scale-in, Auto Scaling attempts to remove ECS instances in descending order of vCPU unit price. When the scaling configuration specifies preemptible billing methods for multiple instance types, spot instances are preferentially created. You can use the CompensateWithOnDemand parameter to specify whether Auto Scaling automatically attempts to create pay-as-you-go instances when spot instances cannot be created.

  Note

  COST_OPTIMIZED takes effect only when the scaling configuration specifies multiple instance types or uses spot instances.

• BALANCE: ECS instances are evenly distributed across the multiple zones specified for the scaling group. If the zones become unbalanced due to reasons such as insufficient inventory, you can call the RebalanceInstance operation to rebalance resources.

• COMPOSABLE: A composite policy that allows you to customize a combination of the preceding multi-zone scaling policies. You can combine the preceding policies for active instance types based on your billable methods as needed.

Specifies whether to evenly distribute the capacity of the scaling group across multiple zones. This parameter takes effect only when the MultiAZPolicy parameter is set to COMPOSABLE. Valid values:

• true: The capacity of the scaling group is evenly distributed across multiple zones.

• false: The capacity of the scaling group is not evenly distributed across multiple zones.

Default value: false.

The capacity allocation strategy that determines how the scaling group selects available instance types to meet capacity requirements. The capacity allocation strategy applies to both pay-as-you-go and spot capacity. This parameter takes effect only when the MultiAZPolicy parameter is set to COMPOSABLE. Valid values:

• priority: Instances are created in the order of the configured instance types.

• lowestPrice: Instances are created in ascending order of vCPU unit price.

Default value: priority.

The spot capacity allocation strategy. You can use this parameter to separately specify the allocation strategy for spot capacity. This parameter takes effect only when the MultiAZPolicy parameter is set to COMPOSABLE. Valid values:

• priority: Instances are created in the order of the configured instance types.

• lowestPrice: Instances are created in ascending order of vCPU unit price.

Default value: priority.

The maximum amount of time that an instance can remain in the scaling group. Unit: seconds.

Valid values: 0 or [86400, Integer.maxValue]. A value of 0 clears the previously set MaxInstanceLifetime value (that is, MaxInstanceLifetime is not set).

Default value: null.

The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function). This parameter takes effect only when the first scale-in policy in RemovalPolicies is set to CustomPolicy.

Specifies whether to disable the expected number of instances feature for the scaling group. Valid values:

• false: Enables the expected number of instances feature.

• true: Disables the expected number of instances feature.

The reclaim mode of the scaling group. Valid values:

• recycle: The scaling group uses the shutdown and recycle mode.

• release: The scaling group uses the release mode.

• forcerelease: The scaling group uses the forced release mode.

  Note

  If you select forcerelease, running instances are forcefully released during scale-in activities. Forcefully releasing an instance is equivalent to a power-off operation, which erases temporary data in the memory and storage of the instance. The data cannot be recovered. Proceed with caution.

• forcerecycle: The scaling group uses the forced shutdown and recycle mode.

  Note

  If you select forcerecycle, running instances are forcefully shut down during scale-in activities. Forcefully shutting down an instance is equivalent to a power-off operation, which erases temporary data in the memory and storage of the instance. The data cannot be recovered. Proceed with caution.

ScalingPolicy specifies the reclaim mode of the scaling group. However, the specific action taken when an instance is removed from the scaling group is determined by the RemovePolicy parameter of RemoveInstances. For more information, see RemoveInstances.

The timeout period for waiting for an ECS instance to stop during a scale-in process. Unit: seconds. Valid values: 30 to 240.

• If this parameter is set, the system waits up to the StopInstanceTimeout period for the instance to stop. After the timeout, the scale-in process continues regardless of whether the instance is stopped.

• If this parameter is not set, the system waits indefinitely for the instance to stop. The scale-in process continues only after the instance is stopped. If the instance fails to stop, the scale-in process will rollback and the scale-in fails.

• Setting this parameter to 0 clears the parameter configuration.

The zone balancing mode. This parameter takes effect only when zone balancing is enabled. Valid values:

• BalancedBestEffort: When resource creation fails in a zone, the system falls back to other zones to ensure best-effort resource delivery.

• BalancedOnly: When resource creation fails in a zone, the system does not fall back to other zones. The scale-out activity partially succeeds to prevent excessive imbalance of resources across zones.

Default value: BalancedBestEffort.

Specifies whether to enable automatic rebalancing for the scaling group. This parameter takes effect only when BalancedOnly is enabled for a zone-balanced scaling group. Valid values:

• false: Automatic rebalancing is disabled.

• true: When automatic rebalancing is enabled, the scaling group automatically detects the capacity across zones. When the capacity is unbalanced across zones, the scaling group proactively scales in and out to rebalance the capacity.

Default value: false.