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 provides instance configurations for 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 an existing ECS instance that provides instance configurations for Auto Scaling to create a scaling configuration.

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

The minimum number of ECS instances that must be contained in the scaling group. If 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 that can be contained in the scaling group. If 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 in the scaling group 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 maximum number of instances that a scaling group can contain.

For example, if a scaling group can contain up to 2,000 instances, the value range of the MaxSize parameter is 0 to 2000.

The cooldown period after a scaling activity is complete. Valid values: 0 to 86400. Unit: seconds.

During the cooldown period, Auto Scaling executes only scaling activities that are triggered by CloudMonitor 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 maximum number of CLB instances that you can associate 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 maximum number of ApsaraDB RDS instances that you can associate with a scaling group.

The first 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 scale-in policy (Function).

The scaling configuration source specified by the OldestScalingConfiguration setting can be a scaling configuration or a launch template. You can specify CustomPolicy only as the value of the RemovalPolicy.1 parameter. If you set the RemovalPolicy.1 parameter to CustomPolicy, you must also specify the CustomPolicyARN parameter.

The second 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 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 preferentially creates ECS instances whose vCPUs are provided at the lowest price and removes ECS instances whose vCPUs are provided at the highest price. 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.
• COMPOSABLE: You can combine the preceding policies based on your business requirements.

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 mode 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 the RemoveInstances topic.

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token 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 that must be contained 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 preferentially creates pay-as-you-go instances.

If you set the MultiAZPolicy parameter to COMPOSABLE Policy, the default value of this parameter is 0.

The percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances reaches the requirement. Valid values: 0 to 100.

If you set the MultiAZPolicy parameter to COMPOSABLE Policy, the default value of this parameter is 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 which indicates that 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 provided due to reasons such as cost-related issues and insufficient resources. This parameter is available only if you set the MultiAZPolicy parameter to COST_OPTIMIZED. Valid values:

• true
• false

Default value: true.

The number of instance types that you want to specify. Auto Scaling evenly creates preemptible instances of multiple instance types that are provided at the lowest price in the scaling group. Valid values: 1 to 10.

If you set the MultiAZPolicy parameter to COMPOSABLE, the default value of this parameter is 2.

The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances. 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 the 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 vSwitches. If you specify 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.

If you specify multiple vSwitches, take note of the following items:

• The vSwitches must belong to the same VPC.
• The vSwitches can belong to different zones.
• The vSwitches are sorted in ascending order of priority. The first vSwitch that is specified by the VSwitchIds.N 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 after the lifecycle hook of the scaling group times out. Valid values:

• CONTINUE: continues to respond to scaling requests.
• ABANDON: releases ECS instances that are created during scale-outs, or removes ECS instances from the scaling group during scale-ins.

If multiple lifecycle hooks in the scaling group are triggered during a scale-in and you set the LifecycleHook.N.DefaultResult parameter to ABANDON for one of the lifecycle hooks, Auto Scaling immediately performs the action after the lifecycle hook whose LifecycleHook.N.DefaultResult parameter 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. The action that Auto Scaling performs is determined by the value of the LifecycleHook.N.DefaultResult parameter that you set for the lifecycle hook that last times 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 activities to which you want to apply the lifecycle hook. Valid values:

• SCALE_OUT: scale-outs
• SCALE_IN: scale-ins

The fixed string that you want to include in a notification. When a lifecycle hook takes effect, Auto Scaling sends a notification. 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. If you specify the NotificationMetadata parameter, you must also specify the 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 notification method can be a Message Service (MNS) queue or an MNS topic. Specify the value of this parameter 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 action specified by the DefaultResult parameter. 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 the backend vServer group.

For more information, see the AttachVServerGroups topic.

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

For more information, see the AttachVServerGroups topic.

The port number that is used by an ECS instance after Auto Scaling adds the ECS instance to the backend vServer group. Valid values: 1 to 65535.

For more information, see the AttachVServerGroups topic.

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

For more information, see the AttachVServerGroups topic.

The key of tag N that you want to add to the scaling group.

The value of tag N that you want to add to the scaling group.

Specifies whether to propagate tag N that you want to add to the scaling group. Valid values:

• true: propagates tag N to instances that are newly created and does not propagate tag N to instances that are already running in the scaling group.
• false: does not propagate tag N to any instances.

Default value: false.

Instance type N that you want to use to override 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 the instances, you must specify the LaunchTemplateOverride.N.InstanceType and LaunchTemplateOverride.N.WeightedCapacity parameters.

You can specify N instance types by using the Extended Configurations feature of the launch template. Valid values of N: 1 to 10.

For information about the valid values of InstanceType in InstanceTypeOverride.N.InstanceType, see the Overview of instance families topic.

The weight of instance type N. The weight of an instance type specifies the capacity of an 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 the 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 maximum bid price of instance type N that is specified by the LaunchTemplateOverride.N.InstanceType parameter. You can specify N instance types by using the Extended Configurations feature of the launch template. Valid values of N: 1 to 10.

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. Go to Quota Center to check the maximum number of ALB server groups that you can associate with a scaling group.

The weight of an ECS instance after Auto Scaling adds the ECS instance to ALB server group N as a backend server. If you increase the weight of an ECS instance in ALB server group N, the number of access requests that are forwarded to the ECS instance also increases. If you set the Weight parameter of an ECS instance in ALB server group N 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 that is used by an ECS instance after Auto Scaling adds the ECS instance to ALB server group N. Valid values: 1 to 65535.

N specifies the serial number of the ALB server group.

The ID of server group N.

The type of server group N. Valid values:

• ALB
• NLB

The weight of an ECS instance after Auto Scaling adds the ECS instance to server group N as a backend server. Valid values: 0 to 100.

If you increase the weight of an ECS instance in server group N, the number of access requests that are forwarded to the ECS instance also increases. If you set the Weight parameter of an ECS instance in server group N to 0, no access requests are forwarded to the ECS instance.

The port number that is used by an ECS instance in the scaling group after Auto Scaling adds the ECS instance to server group N. Valid values: 1 to 65535.

Specifies whether to evenly distribute instances in the scaling group across multiple zones. This parameter is available only if 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. This parameter is available only if you set the MultiAZPolicy parameter to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on the specified orders of the instance types 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 is available only if you set the MultiAZPolicy parameter to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on the specified orders of the instance types 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 an instance in the scaling group. Unit: seconds.

Valid values: 86400 to the value of the Integer.maxValue parameter.

Default value: null.

The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function). This parameter is available only if you specify CustomPolicy as the value of the RemovalPolicy.1 parameter.

The ID of the resource group to which you want to add the scaling group.

The ID of the request.

The ID of the scaling group.