Auto Scaling:CreateScalingGroup

The operation that you want to perform. Set the value to CreateScalingGroup.

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

If you do not specify this parameter, the value of the ScalingGroupId parameter is used.

The ID of the launch template that is used by Auto Scaling to create instances.

The version number of the launch template. Valid values:

• A fixed template version number.
• Default: the default template version.
• Latest: the latest template version.

The ID of the ECS instance. Auto Scaling obtains configuration information based on the ECS instance and uses the information to create a scaling configuration.

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

The minimum number of ECS instances allowed in the scaling group. When the number of ECS instances in the scaling group is less than the value of the MinSize parameter, Auto Scaling automatically creates ECS instances until the number of instances in the scaling group is equal to the minimum number.

The maximum number of ECS instances allowed in the scaling group. When the number of ECS instances in the scaling group is greater than the value of the MaxSize parameter, Auto Scaling automatically removes ECS instances until the number of instances is equal to the maximum number.

The value range of the MaxSize parameter varies based on the instance quota. You can go to Quota Center to check the quota of instances that can be added to a scaling group.

For example, if the quota of instances that can be added to a scaling group is 2,000, the value range of the MaxSize parameter is 0 to 2000.

The cooldown time of the scaling group after a scale-in or scale-out activity is competed. Valid values: 0 to 86400. Unit: seconds.

During the cooldown time, Auto Scaling executes only scaling activities that are triggered by event-triggered tasks.

Default value: 300.

The IDs of the CLB instances that you want to associate with the scaling group. The value can be a JSON array that contains multiple CLB instance IDs. Separate multiple IDs with commas (,).

You can associate only a limited number of CLB instances with a scaling group. Go to Quota Center to check the quota of CLB instances that can be associated with a scaling group.

The IDs of the ApsaraDB RDS instances that you want to associate with the scaling group. The value can be a JSON array that contains multiple ApsaraDB RDS instance IDs. Separate multiple IDs with commas (,).

You can associate only a limited number of ApsaraDB RDS instances with a scaling group. Go to Quota Center to check the quota of ApsaraDB RDS instances that can be associated with a scaling group.

The first step of the instance removal policy. You cannot set the RemovalPolicy.1 parameter, the RemovalPolicy.2 parameter, and the RemovalPolicy.3 parameter to the same value.

• OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.
• NewestInstance: removes ECS instances that are most recently added to the scaling group.
• OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.
• CustomPolicy: removes ECS instances based on the custom scaling policy (Function).

The scaling configuration mentioned in the OldestScalingConfiguration setting refers to the instance configuration source of a scaling group. The instance configuration source can be a scaling configuration or a launch template. The CustomPolicy setting is available only for the RemovalPolicies parameter. If you set the RemovalPolicies parameter to CustomPolicy, you must also specify the CustomPolicyARN parameter.

The second step of the instance removal policy. You cannot set the RemovalPolicy.1 parameter, the RemovalPolicy.2 parameter, and the RemovalPolicy.3 parameter to the same value. Valid values:

• OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.
• NewestInstance: removes ECS instances that are most recently added to the scaling group.
• OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.

The third step of the instance removal policy. You cannot set the RemovalPolicy.1 parameter, the RemovalPolicy.2 parameter, and the RemovalPolicy.3 parameter to the same value. Valid values:

• OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.
• NewestInstance: removes ECS instances that are most recently added to the scaling group.
• OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.

The ID of the vSwitch. If you specify the VSwitchId parameter, the network type of the scaling group is VPC.

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

• PRIORITY: Auto Scaling scales ECS instances based on the priority of the vSwitch that is specified by the VSwitchIds.N parameter. Auto Scaling preferentially scales instances in the zone where the vSwitch that has the highest priority resides. If the scaling fails, Auto Scaling scales instances in the zone where the vSwitch that has the next highest priority resides.
• COST_OPTIMIZED: Auto Scaling creates ECS instances whose vCPUs are provided at the lowest price during scale-out activities and removes ECS instances whose vCPUs are provided at the highest price during scale-in activities. If preemptible instance types are specified in the scaling configuration, Auto Scaling preferentially creates preemptible instances. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.
  Note The COST_OPTIMIZED setting takes effect only when you specify multiple instance types or when you specify at least one preemptible instance type.

• BALANCE: Auto Scaling evenly distributes ECS instances across zones that are specified for the scaling group. If ECS instances are unevenly distributed across zones due to insufficient resources, you can call the RebalanceInstance operation to evenly distribute the instances across the zones.

  Default value: PRIORITY.

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

• NONE: Auto Scaling does not perform health checks on instances in the scaling group.
• ECS: Auto Scaling performs health checks on ECS instances in the scaling group.

Default value: ECS.

The reclaim mode of the scaling group. Valid values:

• recycle: economical mode.
• release: release mode.

ScalingPolicy specifies the reclaim modes of scaling groups. The policy that is used to remove ECS instances from scaling groups is specified by the RemovePolicy parameter of the RemoveInstances operation. For more information, see RemoveInstances.

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value 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 minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling creates pay-as-you-go instances.

The percentage of pay-as-you-go instances among the excess instances when the requirement on the minimum number of pay-as-you-go instances is met. Valid values: 0 to 100.

Specifies whether to supplement preemptible instances. If you set this parameter to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives a system message that indicates the preemptible instance is to be reclaimed.

Specifies whether to automatically create pay-as-you-go instances to meet the requirement on the number of ECS instances when the expected capacity of preemptible instances cannot be fulfilled due to reasons such as costs and insufficient resources. This parameter takes effect only when you set the MultiAZPolicy parameter to COST_OPTIMIZED. Valid values:

• true
• false

Default value: true.

The number of instance types. The system creates preemptible instances of multiple instance types that are provided at the lowest price in the scaling group. Valid values: 1 to 10.

The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances that you specify. The expected number cannot be greater than the value of the MaxSize parameter and cannot be less than the value of the MinSize parameter.

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

• true: enables deletion protection for the scaling group. This way, the scaling group cannot be deleted.
• false: disables deletion protection for the scaling group.

Default value: false.

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

• ECS: ECS instances
• ECI: elastic container instances

Default value: ECS.

The ID of the elastic container instance.

The IDs of the vSwitches. You can specify 1 to 5 vSwitches. If you use the VSwitchIds.N parameter, the VSwitchId parameter is ignored. If you specify the VSwitchIds.N parameter, the network type of the scaling group is VPC.

When you specify multiple vSwitches, the following rules apply:

• The vSwitches must belong to the same VPC.
• The vSwitches can belong to different zones.
• The vSwitches are sorted in ascending order. The first vSwitch specified by using the VSwitchIds parameter has the highest priority. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.

The action that Auto Scaling performs when the lifecycle hook times out. Valid values:

• CONTINUE: Auto Scaling continues to respond to scaling requests.
• ABANDON: Auto Scaling releases ECS instances that are created during scale-out activities, or removes ECS instances from the scaling group during scale-in activities.

If multiple lifecycle hooks in a scaling group are triggered during a scale-in activity and you set the DefaultResult parameter to ABANDON for one of the lifecycle hooks, Auto Scaling immediately performs the action after the lifecycle hook whose DefaultResult is set to ABANDON times out. In this case, other lifecycle hooks time out ahead of schedule. In other cases, Auto Scaling performs the action only after all lifecycle hooks time out.

Default value: CONTINUE.

The name of the lifecycle hook. After you specify this parameter, you cannot change the name of the lifecycle hook. If you do not specify this parameter, the name of the lifecycle hook is the same as the ID of the lifecycle hook.

The type of the scaling activity to which the lifecycle hook applies. Valid values:

• SCALE_OUT
• SCALE_IN

The fixed string that is included in a notification when Auto Scaling sends the notification that indicates that the scaling activity is pending. The value of this parameter cannot exceed 128 characters in length. Auto Scaling sends the value of the NotificationMetadata parameter together with the notification. This helps you categorize your notifications. The LifecycleHook.N.NotificationMetadata parameter takes effect only after you specify the LifecycleHook.N.NotificationArn parameter.

The Alibaba Cloud Resource Name (ARN) of the notification method that Auto Scaling uses to send a notification when a lifecycle hook takes effect. This method can be a Message Service (MNS) queue or an MNS topic. Specify the value in the following format: acs:ess:{region}:{account-id}:{resource-relative-id}.

• region: the region where the scaling group resides
• account-id: the ID of the Alibaba Cloud account

Examples:

• MNS queue: acs:ess:{region}:{account-id}:queue/{queuename}
• MNS topic: acs:ess:{region}:{account-id}:topic/{topicname}

The period of time before the lifecycle hook times out. After the lifecycle hook times out, Auto Scaling performs the default action. Valid values: 30 to 21600. Unit: seconds.

After you create a lifecycle hook, you can call the RecordLifecycleActionHeartbeat operation to prolong the timeout period of the lifecycle hook. You can also call the CompleteLifecycleAction operation to end the timeout period ahead of schedule.

Default value: 600.

The ID of vServer group N.

For more information, see AttachVServerGroups.

The weight of the ECS instance as a backend server after the instance is added to vServer group N. If you increase the weight of an ECS instance, the number of access requests that are forwarded to the ECS instance increases. If you set the Weight parameter for an ECS instance to 0, no access requests are forwarded to the ECS instance. Valid values: 0 to 100. Default value: 50.

Valid values of N: 1 to 5.

For more information, see AttachVServerGroups.

The port number used by the ECS instance after the instance is added to vServer group N. Valid values: 1 to 65535.

For more information, see AttachVServerGroups.

The ID of the CLB instance to which vServer group N belongs.

For more information, see AttachVServerGroups.

The key of tag N of the scaling group.

The value of tag N of the scaling group.

Specifies whether tag N can be propagated. Valid values:

• true: Tag N that is added to the scaling group can be propagated to new instances. Tag N that is added to the scaling group cannot be propagated to existing instances in the scaling group.
• false: Tag N cannot be propagated.

Default value: false.

Instance type N. The instance type that is specified by using this parameter overrides the instance type that is specified in the launch template. If you want to scale instances in the scaling group based on the weighted capacity of instances, you must specify the LaunchTemplateOverride.N.InstanceType and LaunchTemplateOverride.N.WeightedCapacity parameters at the same time.

You can specify N instance types in the extended configurations of the launch template. Valid values of N: 1 to 10.

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

The weight of instance type N. The weight of an instance type specifies the capacity of a single instance of the instance type in the scaling group. If you want to scale instances in the scaling group based on the weighted capacity of instances, you must specify the LaunchTemplateOverride.N.WeightedCapacity parameter after you specify the LaunchTemplateOverride.N.InstanceType parameter. The values of N in the two parameters must be the same.

A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.

Performance metrics, such as the number of vCPUs and the memory size of each instance type, may vary. You can specify different weights for different instance types based on your business requirements.

Example:

• Current capacity: 0
• Expected capacity: 6
• Capacity of ecs.c5.xlarge: 4

To meet the expected capacity requirement, Auto Scaling must create two ecs.c5.xlarge instances.

Valid values of WeightedCapacity in the InstanceTypeOverride.N.WeightedCapacity parameter: 1 to 500.

The ID of ALB server group N.

N specifies the serial number of the ALB server group. You can associate only a limited number of ALB server groups with a scaling group. To view the available quota or manually request a quota increase, go to Quota Center.

The weight of the ECS instance as a backend server after the instance is added to ALB server group N. If you increase the weight of an ECS instance in an ALB server group, the number of access requests that are forwarded to the ECS instance increases. If you decrease the weight of an ECS instance in an ALB server group to 0, no access requests are forwarded to the ECS instance. Valid values: 0 to 100.

N specifies the serial number of the ALB server group.

The port number used by the ECS instance after the instance is added to ALB server group N. Valid values: 1 to 65535.

N specifies the serial number of the ALB server group.

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

• true
• false

Default value: false.

The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create the required number of instances. The policy can be applied to pay-as-you-go instances and preemptible instances at the same time. This parameter takes effect only when you set the MultiAZPolicy parameter to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on the specified order to create the required number of instances.
• lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of instances.

Default value: priority.

The allocation policy of preemptible instances. You can use this parameter to individually specify the allocation policy of preemptible instances. This parameter takes effect only when you set the MultiAZPolicy parameter to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on the specified order to create the required number of preemptible instances.
• lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of preemptible instances.

Default value: priority.

The maximum life span of the instance in the scaling group. Unit: seconds.

Valid values: 86400 to Integer.maxValue.

Default value: null.

The ARN of the custom scaling policy (Function). This parameter takes effect only if you specify CustomPolicy as the first step of the instance removal policy.

The ID of the request.

The ID of the scaling group.