CreateScalingGroup

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

Default value: the value of ScalingGroupId.

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 ID of the instance. When you create a scaling group, the required configuration information is obtained from the specified instance, and a scaling configuration is created through automatic creation.

The region ID of the scaling group. For more information, see Regions and zones.

The minimum number of instances in the scaling group. When the number of instances in the scaling group is less than the value of MinSize, Auto Scaling uses automatic creation to create instances.

The maximum number of instances in the scaling group. When the number of instances in the scaling group is greater than the value of MaxSize, Auto Scaling automatically removes instances.

The value range of MaxSize depends on your Auto Scaling usage. Go to Quota Center to view the quota for Maximum Number of Instances in a Scaling Group.

If the quota for Maximum Number of Instances in a Scaling Group is 2000, the value range of MaxSize is 0 to 2000.

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

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

Default value: 300.

The IDs of CLB (formerly SLB) instances. The value is a JSON array that consists of CLB instance IDs separated by commas (,).

The total number of CLB instances that can be associated with a single scaling group depends on your Auto Scaling usage. Go to Quota Center to view the quota for Total Number of Load Balancing Instances That Can Be Associated with a Scaling Group.

The IDs of ApsaraDB RDS instances. The value is a JSON array that consists of ApsaraDB RDS instance IDs separated by commas (,).

The total number of ApsaraDB RDS instances that can be associated with a single scaling group depends on your Auto Scaling usage. Go to Quota Center to view the quota for Total Number of RDS Instances That Can Be Associated with a Scaling Group.

The first-round filter strategy for the scale-in policy. The value must be different from the values of RemovalPolicy.2 and RemovalPolicy.3. 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 scaling configuration mentioned in OldestScalingConfiguration refers to the instance configuration source in the scaling group, including scaling configurations and launch templates. CustomPolicy can only be set as the first-round scale-in policy. When you specify CustomPolicy, you must also specify the CustomPolicyARN parameter.

The second-round filter strategy for the scale-in policy. The value must be different from the values of RemovalPolicy.1 and RemovalPolicy.3. 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-round filter strategy for the scale-in policy. The value must be different from the values of RemovalPolicy.1 and RemovalPolicy.2. 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 vSwitch. If you specify this parameter, the network type of the scaling group is VPC.

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

• PRIORITY: the vSwitch specified first (VSwitchIds.N) has the highest priority. Auto Scaling preferentially attempts to scale instances in the zone where the highest-priority vSwitch resides. If the scaling cannot be completed, Auto Scaling automatically attempts to scale instances in the zone where the next-priority vSwitch resides.

• COST_OPTIMIZED: during scale-out events, Auto Scaling attempts to create ECS instances in ascending order of vCPU unit price. During scale-in events, Auto Scaling attempts to remove ECS instances in descending order of vCPU unit price. If 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 to automatically create pay-as-you-go instances when spot instances cannot be created due to insufficient inventory.

  Note

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

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

• COMPOSABLE: a composable strategy that allows you to combine the preceding multi-zone scaling policies as needed, or further specify parameters for more fine-grained control over the capacity of the scaling group.

Default value: PRIORITY.

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 is used to enable instance health checks for both ECS-type and ECI-type scaling groups).

• LOAD_BALANCER: the instance health status is determined based on load balancing health check results (CLB-type load balancing is not supported).

Default value: ECS.

Specifies the reclaim pattern of the scaling group. Valid values:

• recycle: the scaling group uses the shutdown and reclaim pattern.

• release: the scaling group uses the release pattern.

• forcerelease: the scaling group uses the forced release pattern.

  Note

  If you select forcerelease, running instances are forcefully released during scale-down 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 scaling group uses the forced shutdown and reclaim pattern.

  Note

  If you select forcerecycle, running instances are forcefully shut down during scale-down activities. A forced shutdown 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 revoke pattern of the scaling group. 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 client token that is used to ensure the idempotence of the request.

Generate a value from your client that is unique among different requests. The value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

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 MultiAZPolicy 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 MultiAZPolicy is set to COMPOSABLE, the default value is 100.

Specifies whether to supplement spot instances. When enabled, the scaling group attempts to create new instances to replace spot instances that are about to be reclaimed after a reclamation notification is received.

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 price or inventory reasons. This parameter takes effect only when MultiAZPolicy is set to COST_OPTIMIZED. Valid values:

• true: allowed.

• false: not allowed.

Default value: true.

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

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

The expected number of instances in the scaling group. The scaling group automatically maintains the number of ECS instances at the expected number of instances. The value must not be greater than MaxSize or less than MinSize.

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.

Default value: false.

The type of instances managed by the scaling group. Valid values:

• ECS: the scaling group manages ECS instances.

• ECI: the scaling group manages Elastic Container Instance (ECI) instances.

Default value: ECS.

The instance ID of the ECI instance, which is the container group ID.

Specifies whether to evenly distribute the capacity of the scaling group across multiple zones. This parameter takes effect only when MultiAZPolicy 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 MultiAZPolicy 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 specify the allocation strategy for spot capacity separately. This parameter takes effect only when MultiAZPolicy 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 exist in the scaling group. Unit: seconds.

Valid values: [86400, Integer.maxValue].

Default value: null.

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

The ID of the resource group to which the newly created scaling group belongs.

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

• If this parameter is specified, 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 specified, 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 is rolled back and the scaling activity fails.

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

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

• BalancedOnly: If resource creation fails in a zone, the system does not fall back to other zones. The scaling 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: Disables automatic rebalancing.

• true: Enables automatic rebalancing. The scaling group automatically detects capacity across zones. When zone capacity is imbalanced, the system proactively performs scale-in and scale-out operations to rebalance capacity across zones.

Default value: false.