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 (.).

The minimum number of ECS instances or elastic container instances in the scaling group. When the number of instances in the scaling group is less than MinSize, 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 instances in the scaling group exceeds MaxSize, Auto Scaling automatically removes instances from the scaling group.

The valid values of MaxSize depend on your Auto Scaling usage. Go to Quota Center to check the quota value of Maximum Number of Instances in a Scaling Group.

For example, if the quota value of 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.

指定移出 ECS 实例的第一段伸缩组策略。取值范围：

• OldestInstance：移出最早加入伸缩组的 ECS 实例。

• NewestInstance：移出最新加入伸缩组的 ECS 实例。

• OldestScalingConfiguration：移出最早伸缩配置创建的 ECS 实例。

• CustomPolicy：基于自定义缩容策略 Function 函数移除 ECS 实例。

指定移出 ECS 实例的第二段伸缩组策略。取值范围：

• OldestInstance：移出最早加入伸缩组的 ECS 实例。

• NewestInstance：移出最新加入伸缩组的 ECS 实例。

• OldestScalingConfiguration：移出最早伸缩配置创建的 ECS 实例。

指定移出 ECS 实例的第三段伸缩组策略。取值范围：

• OldestInstance：移出最早加入伸缩组的 ECS 实例。

• NewestInstance：移出最新加入伸缩组的 ECS 实例。

• OldestScalingConfiguration：移出最早伸缩配置创建的 ECS 实例。

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

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

• NONE: no health check is performed.

• 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 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. If this feature is enabled, Auto Scaling creates new instances to replace spot instances that are about to be reclaimed when the system sends a reclamation notification.

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: allows automatic creation.

• false: does not allow automatic creation.

The number of available instance types. Auto Scaling creates spot instances across multiple lowest-cost instance types in a balanced manner. 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. Auto Scaling automatically maintains the number of instances at the expected level. Valid values: MinSize ≤ expected number of instances ≤ MaxSize.

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

• true: enables deletion protection. The scaling group cannot be deleted.

• false: disables deletion protection.

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

• PRIORITY: scales instances based on the priority of the vSwitches (VSwitchIds.N). Auto Scaling preferentially performs scaling in the zone of the highest-priority vSwitch. If scaling cannot be performed in that zone, Auto Scaling automatically attempts the next-priority zone.

• COST_OPTIMIZED: during scale-out, Auto Scaling creates ECS instances in ascending order of vCPU unit price. During scale-in, Auto Scaling removes ECS instances in descending order of vCPU unit price. When the scaling configuration specifies multiple instance types with preemptible billing methods, spot instances are preferentially created. You can use the CompensateWithOnDemand parameter to specify whether Auto Scaling automatically creates 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: allocates ECS instances evenly across the active 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 combine the preceding multi-zone scaling policies as needed. Settings can be customized based on your requirements. This is a composite policy. You can determine whether to combine the preceding multi-zone scaling policies based on your requirements.

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: evenly distributes the capacity across multiple zones.

• false: does not evenly distribute the capacity 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 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: creates instances in the order of the configured instance types.

• lowestPrice: creates instances 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: creates instances in the order of the configured instance types.

• lowestPrice: creates instances 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 any 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 Compute 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 reclaim mode of the scaling group is stop and recycle mode.

• release: the reclaim mode of the scaling group is release mode.

• forcerelease: the reclaim mode of the scaling group is forced release mode.

  Note

  If you select forcerelease, running instances are forcefully released during scale-in activities. A forced release 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 reclaim mode of the scaling group is forced stop and recycle mode.

  Note

  If you select forcerecycle, running instances are forcefully stopped during scale-in activities. A forced stop 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, but the specific action taken when instances are 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 flow. Unit: seconds. Valid values: 30 to 240.

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

• If this parameter is not set, the system waits indefinitely for the instance to stop. The scale-in flow continues only after the instance stops. If the instance fails to stop, the scale-in flow is rolled back and the scale-in fails.

• Setting this parameter to 0 clears the parameter settings.

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 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: disables automatic rebalancing.

• true: enables automatic rebalancing. The scaling group automatically detects capacity across zones and proactively performs scaling to rebalance zone capacity when an imbalance is detected.

Default value: false.