Auto Scaling：CreateScalingGroup

Action

String

Yes

CreateScalingGroup

A required parameter. Set the value to CreateScalingGroup.

ScalingGroupName

String

No

scalinggroup****

The name of the scaling group. The name must be unique within a region.

The name must be 2 to 64 characters in length. It must start with a digit, an uppercase or lowercase letter, or a Chinese character. It can contain digits, underscores (_), hyphens (-), and periods (.).

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

LaunchTemplateId

String

No

lt-m5e3ofjr1zn1aw7****

The ID of the launch template that provides the launch configurations for the scaling group.

LaunchTemplateVersion

String

No

Default

The version of the launch template. Valid values:

• A fixed template version number.

• Default: The default version of the template is always used.

• Latest: The latest version of the template is always used.

InstanceId

String

No

i-28wt4****

The ID of the instance. When you create a scaling group, the system obtains the required configuration information from the specified instance and automatically creates a scaling configuration.

RegionId

String

Yes

cn-qingdao

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

MinSize

Integer

Yes

2

The minimum number of instances in the scaling group. Auto Scaling automatically creates instances if the number of instances in the scaling group is less than the value of MinSize.

MaxSize

Integer

Yes

20

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

The value range of MaxSize depends on your Auto Scaling usage. To view your quota for the maximum number of instances in a single scaling group, go to Quota Center.

If your quota for the maximum number of instances in a single scaling group is 2,000, the value range for MaxSize is 0 to 2,000.

DefaultCooldown

Integer

No

300

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

During the cooldown period, the scaling group does not execute other scaling activities. This parameter is effective only for scaling activities that are triggered by event-triggered tasks.

Default value: 300.

LoadBalancerIds

String

No

["lb-bp1u7etiogg38yvwz****", "lb-bp168cqrux9ai9l7f****", "lb-bp1jv3m9zvj22ufxp****"]

The IDs of Classic Load Balancer (CLB) (formerly SLB) instances. You can specify multiple CLB instance IDs in a JSON array. Separate the IDs with commas (,).

The total number of CLB instances that can be associated with a single scaling group depends on your Auto Scaling usage. To view your quota for the total number of SLB instances that can be associated with a single scaling group, go to Quota Center.

DBInstanceIds

String

No

["rm-bp142f86de0t7****", "rm-bp18l1z42ar4o****", "rm-bp1lqr97h4aqk****"]

The IDs of RDS instances. You can specify multiple RDS instance IDs in a JSON array. Separate the IDs with commas (,).

The total number of RDS instances that can be associated with a single scaling group depends on your Auto Scaling usage. To view your quota for the total number of RDS instances that can be associated with a single scaling group, go to Quota Center.

RemovalPolicy.1

String

No

OldestScalingConfiguration

The first policy for removing instances from the scaling group. This value cannot be the same as the values of RemovalPolicy.2 and RemovalPolicy.3. Valid values:

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

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

• OldestScalingConfiguration: Removes the ECS instance that was created from 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 source of the instance configuration in the group, including scaling configurations and launch templates. CustomPolicy can be set only as the first removal policy. If you set this parameter to CustomPolicy, you must also specify the CustomPolicyARN parameter.

RemovalPolicy.2

String

No

OldestInstance

The second policy for removing instances from the scaling group. This value cannot be the same as the values of RemovalPolicy.1 and RemovalPolicy.3. Valid values:

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

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

• OldestScalingConfiguration: Removes the ECS instance that was created from the earliest scaling configuration.

RemovalPolicy.3

String

No

NewestInstance

The third policy for removing instances from the scaling group. This value cannot be the same as the values of RemovalPolicy.1 and RemovalPolicy.2. Valid values:

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

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

• OldestScalingConfiguration: Removes the ECS instance that was created from the earliest scaling configuration.

VSwitchId

String

No

vsw-bp14zolna43z266bq****

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

MultiAZPolicy

String

No

PRIORITY

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

• PRIORITY: The vSwitch that is specified first by VSwitchIds.N has the highest priority. Auto Scaling preferentially scales instances in the zone where the vSwitch with the highest priority is located. If the scaling fails, Auto Scaling automatically scales instances in the zone where the vSwitch with the next highest priority is located.

• COST_OPTIMIZED: During a scale-out, Auto Scaling creates ECS instances in ascending order of vCPU unit price. During a scale-in, Auto Scaling removes ECS instances in descending order of vCPU unit price. If the scaling configuration specifies multiple instance types with a preemptible billing method, preemptible instances are preferentially created. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances if preemptible instances cannot be created due to reasons such as insufficient inventory.

  Note

  COST_OPTIMIZED takes effect only when multiple instance types are specified in the scaling configuration or spot instances are used.

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

• COMPOSABLE: A composite policy. You can combine the preceding policies as needed. You can also specify additional parameters to finely control the capacity of the scaling group.

Default value: PRIORITY.

HealthCheckType

String

No

ECS

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

• NONE: No health checks are performed.

• ECS: Health checks are performed on instances in the scaling group. This value enables instance health checks for both ECS and ECI scaling groups.

• LOAD_BALANCER: The health status of an instance is determined by the health check results of the associated load balancer. This option does not support CLB.

Default value: ECS.

ScalingPolicy

String

No

recycle

The reclaim mode of the scaling group. Valid values:

• recycle: The scaling group is in economical mode.

• release: The scaling group is in release mode.

• forcerelease: The scaling group is in forced release mode.

  Note

  If you set this parameter to forcerelease, the system forcibly releases `Running` instances during a scale-in. A forced release is equivalent to a power-off operation. Data in the memory and ephemeral storage of the instance is erased and cannot be recovered. Use this option with caution.

• forcerecycle: The scaling group is in forced economical mode.

  Note

  If you set this parameter to forcerecycle, the system forcibly shuts down `Running` instances during a scale-in. A forced shutdown is equivalent to a power-off operation. Data in the memory and ephemeral storage of the instance is erased and cannot be recovered. Use this option 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 the RemoveInstances operation. For more information, see RemoveInstances.

ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

A client token to ensure the idempotence of the request.

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

OnDemandBaseCapacity

Integer

No

30

The minimum number of pay-as-you-go instances that are required for the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than this value, Auto Scaling preferentially creates pay-as-you-go instances.

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

OnDemandPercentageAboveBaseCapacity

Integer

No

20

The percentage of pay-as-you-go instances among the excess instances when 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.

SpotInstanceRemedy

Boolean

No

true

Specifies whether to enable supplementation of spot instances. If this parameter is set to true, Auto Scaling creates a new instance to replace a spot instance that is about to be reclaimed.

CompensateWithOnDemand

Boolean

No

true

This parameter takes effect only when MultiAZPolicy is set to COST_OPTIMIZED. It specifies whether to allow automatic creation of pay-as-you-go instances to meet the required number of ECS instances if spot instances cannot be created due to reasons such as price or insufficient inventory. Valid values:

• true: Yes.

• false: No.

Default value: true.

SpotInstancePools

Integer

No

5

The number of instance types that you can specify. The scaling group creates spot instances of the specified instance types in a balanced manner and at the lowest cost. Valid values: 1 to 10.

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

DesiredCapacity

Integer

No

5

The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the number of ECS instances at the expected value. The value of this parameter must be less than or equal to MaxSize and greater than or equal to MinSize.

GroupDeletionProtection

Boolean

No

true

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

• true: Enables deletion protection for the scaling group. The scaling group cannot be deleted.

• false: Disables deletion protection for the scaling group.

Default value: false.

GroupType

String

No

ECS

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

• ECS: The scaling group manages ECS instances.

• ECI: The scaling group manages ECI instances.

Default value: ECS.

ContainerGroupId

String

No

eci-uf6fonnghi50u374****

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

VSwitchIds.N

String

No

vsw-bp14zolna43z266bq****

The IDs of one or more vSwitches. If you specify this parameter, the VSwitchId parameter is ignored. If you specify this parameter, the network type of the scaling group is VPC.

If you specify multiple vSwitches:

• They must belong to the same VPC.

• They can belong to different zones.

• The priority of the vSwitches is sorted in ascending order of the number N. 1 indicates the highest priority. When it is not possible to create ECS instances in the zone of the vSwitch with a higher priority, the system automatically selects the vSwitch with the next highest priority to create ECS instances.

LifecycleHook.N.DefaultResult

String

No

CONTINUE

The action to take after the wait state ends. Valid values:

• CONTINUE: Continues to respond to the scale-out or scale-in activity.

• ABANDON: Directly releases the ECS instances created during the scale-out activity or removes the ECS instances from the scaling group during the scale-in activity.

If a scale-in (SCALE_IN) activity triggers multiple lifecycle hooks, and one of them has DefaultResult set to ABANDON, the other wait states end when the wait state for that hook ends. In all other cases, the next action is based on the action of the last wait state to end.

Default value: CONTINUE.

LifecycleHook.N.LifecycleHookName

String

No

lifecyclehook****

The name of the lifecycle hook. The name cannot be modified after you specify it. If you do not specify this parameter, the ID of the lifecycle hook is used by default.

LifecycleHook.N.LifecycleTransition

String

No

SCALE_OUT

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

• SCALE_OUT: a scale-out activity.

• SCALE_IN: a scale-in activity.

LifecycleHook.N.NotificationMetadata

String

No

Test

The fixed string of information for the wait state of a scaling activity. The value of this parameter cannot exceed 128 characters in length. When Auto Scaling sends a message to a notification recipient, it includes the value of this parameter. This helps you manage and categorize notifications. This parameter takes effect only when you specify the NotificationArn parameter.

LifecycleHook.N.NotificationArn

String

No

acs:ess:cn-hangzhou:1111111111:queue/queue2

The Alibaba Cloud Resource Name (ARN) of the notification recipient for the lifecycle hook. You can specify a Simple Message Queue (formerly MNS) queue or topic. The ARN must be in the following format: acs:ess:{region}:{account-id}:{resource-relative-id}.

• region: the region where the scaling group is located.

• account-id: the Alibaba Cloud account ID.

Examples:

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

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

LifecycleHook.N.HeartbeatTimeout

Integer

No

600

The wait time of the lifecycle hook for a scaling activity. After the wait time expires, the next action is performed. Valid values: 30 to 21600. Unit: seconds.

After you create a lifecycle hook, you can call RecordLifecycleActionHeartbeat to extend the wait time of an ECS instance, or call CompleteLifecycleAction to end the wait state of the scaling activity ahead of schedule.

Default value: 600.

VServerGroup.N.VServerGroupAttribute.N.VServerGroupId

String

No

rsp-bp1443g77****

The ID of the vServer group.

For more information, see AttachVServerGroups.

VServerGroup.N.VServerGroupAttribute.N.Weight

Integer

No

100

After Auto Scaling adds an instance to a vServer group, this is the weight of the instance as a backend server. A higher weight means the instance is allocated more access requests. If the weight is 0, the instance does not receive access requests. Valid values: 0 to 100. Default value: 50.

For more information, see AttachVServerGroups.

VServerGroup.N.VServerGroupAttribute.N.Port

Integer

No

22

After Auto Scaling adds an instance to a vServer group, this is the port number used by the instance. Valid values: 1 to 65535.

For more information, see AttachVServerGroups.

VServerGroup.N.LoadBalancerId

String

No

lb-bp1u7etiogg38yvwz****

The ID of the CLB (formerly SLB) instance to which the vServer group belongs.

For more information, see AttachVServerGroups.

Tag.N.Key

String

No

Department

The key of the tag for the scaling group.

Tag.N.Value

String

No

Finance

The value of the tag for the scaling group.

Tag.N.Propagate

Boolean

No

false

Indicates whether the tag can be propagated. Valid values:

• true: The tags of the scaling group are propagated only to newly created instances, not to instances that are already running in the scaling group.

• false: The tags of the scaling group are not propagated to instances.

Default value: false.

LaunchTemplateOverride.N.InstanceType

String

No

ecs.c5.xlarge

If you want the scaling group to scale instances based on the capacity of instance types, specify both this parameter and LaunchTemplateOverride.N.WeightedCapacity.

This parameter specifies an instance type that is used to override the instance type in the launch template. You can specify N values for this parameter to support N instance types. N specifies the number of instance types. Valid values of N: 1 to 20.

For the valid values of InstanceType, see Instance families.

LaunchTemplateOverride.N.WeightedCapacity

Integer

No

4

If you want the scaling group to scale instances based on the capacity of instance types, specify this parameter after you specify LaunchTemplateOverride.N.InstanceType. The values of N for these two parameters must be the same.

This parameter specifies the weight of the instance type. The weight indicates the capacity of a single instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity.

Because performance metrics such as the number of vCPUs and memory size vary for each instance type, you can configure different weights for different instance types based on your needs.

Example:

• Current capacity: 0

• Expected capacity: 6

• ecs.c5.xlarge capacity: 4

To meet the expected capacity, the scaling group will scale out two ecs.c5.xlarge instances.

Valid values for WeightedCapacity: 1 to 500.

LaunchTemplateOverride.N.SpotPriceLimit

Float

No

0.025

The maximum bid price for the instance type that is specified by LaunchTemplateOverride.N.InstanceType. You can specify N values for this parameter to support N instance types. N specifies the number of instance types. Valid values of N: 1 to 20.

AlbServerGroup.N.AlbServerGroupId

String

No

sgp-ddwb0y0g6y9bjm****

The ID of the ALB server group.

N is the number of the ALB server group. The number of ALB server groups that can be associated with a scaling group is limited. To view or request an increase in the quota, go to Quota Center.

AlbServerGroup.N.Weight

Integer

No

100

After Auto Scaling adds an instance to an ALB server group, this is the weight of the instance as a backend server. A higher weight means the instance is allocated more access requests. If the weight is 0, the instance does not receive access requests. Valid values: 0 to 100.

N is the number of the ALB server group.

AlbServerGroup.N.Port

Integer

No

22

After Auto Scaling adds an instance to an ALB server group, this is the port number used by the instance. Valid values: 1 to 65535.

N is the number of the ALB server group.

ServerGroup.N.ServerGroupId

String

No

sgp-5yc3bd9lfyh*****

The ID of the server group.

ServerGroup.N.Type

String

No

ALB

The type of the server group. Valid values:

• ALB: Application Load Balancer.

• NLB: Network Load Balancer.

ServerGroup.N.Weight

Integer

No

100

After Auto Scaling adds an instance to a server group, this is the weight of the instance as a backend server. Valid values: 0 to 100.

A higher weight means the instance is allocated more access requests. If the weight is 0, the instance does not receive access requests.

ServerGroup.N.Port

Integer

No

22

After Auto Scaling adds an instance to a server group, this is the port number used by the instance. Valid values: 1 to 65535.

AzBalance

Boolean

No

false

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.

AllocationStrategy

String

No

priority

The capacity allocation policy. This policy determines how the scaling group selects available instance types to meet the capacity requirements. The policy applies to both pay-as-you-go and spot instances. 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 based on the vCPU unit price from lowest to highest.

Default value: priority.

SpotAllocationStrategy

String

No

lowestPrice

The allocation policy for spot instances. You can use this parameter to separately specify the allocation policy for spot instances. 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 based on the vCPU unit price from lowest to highest.

Default value: priority.

MaxInstanceLifetime

Integer

No

null

The maximum lifetime of an instance in the scaling group. Unit: seconds.

Valid values: [86400, Integer.maxValue].

Default value: null.

CustomPolicyARN

String

No

acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name

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

ResourceGroupId

String

No

rg-123****

The ID of the resource group to which the new scaling group belongs.

LoadBalancerConfig.N.LoadBalancerId

String

No

147b46d767c-cn-qingdao-cm5****

The ID of the CLB (formerly SLB) instance.

LoadBalancerConfig.N.Weight

Integer

No

10

After Auto Scaling adds an instance to a CLB (formerly SLB) server group, this is the weight of the instance as a backend server. A higher weight means the instance is allocated more access requests. If the weight is 0, the instance does not receive access requests.

Valid values: 0 to 100.

HealthCheckTypes.N

String

No

ECS

The list of health check methods for the scaling group. Valid values:

• NONE: No health checks are performed.

• ECS: Health checks are performed on instances in the scaling group. This value enables instance health checks for both ECS and ECI scaling groups.

• LOAD_BALANCER: The health status of an instance is determined by the health check results of the associated load balancer. This option does not support CLB.

Default value: ECS.

DBInstance.N.DBInstanceId

String

No

rm-m5eqju85s45mu0***

The ID of the database instance.

DBInstance.N.Type

String

No

RDS

The type of the database. Valid values:

• RDS

• Redis

• MongoDB

Default value: RDS.

DBInstance.N.AttachMode

String

No

SecurityIp

The method for associating the database with the scaling group. Valid values:

• SecurityIp: The IP whitelist mode. The private IP addresses of scaled-out instances are automatically added to the IP whitelist of the database. This mode is supported only for RDS databases.

• SecurityGroup: The security group mode. The security group of the scaling configuration is added to the security group whitelist of the database. This allows instances in the security group to access the database.

StopInstanceTimeout

Integer

No

60

The timeout period for waiting for an ECS instance to stop during a scale-in. Unit: seconds.

Valid values: 30 to 240.

CapacityOptions.OnDemandBaseCapacity

Integer

No

30

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

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

CapacityOptions.OnDemandPercentageAboveBaseCapacity

Integer

No

20

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

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

CapacityOptions.CompensateWithOnDemand

Boolean

No

true

This parameter takes effect only when MultiAZPolicy is set to COST_OPTIMIZED. It specifies whether to allow automatic creation of pay-as-you-go instances to meet the required number of ECS instances if spot instances cannot be created due to reasons such as price or insufficient inventory. Valid values:

• true: Yes.

• false: No.

Default value: true.

CapacityOptions.SpotAutoReplaceOnDemand

Boolean

No

false

If you enable CompensateWithOnDemand, the system may create pay-as-you-go instances if spot instances are unavailable. This can cause the proportion of pay-as-you-go instances to exceed the value of OnDemandPercentageAboveBaseCapacity. To prevent these pay-as-you-go instances from running for a long time, the system attempts to replace the excess pay-as-you-go instances with spot instances. Valid values:

• true: Yes.

• false: No.

Default value: false.

CapacityOptions.PriceComparisonMode

String

No

PricePerUnit

The price comparison mode for the cost optimization policy of the scaling group. Valid values:

• PricePerUnit: Compares prices based on the price per unit of capacity.

  The capacity of an instance in a scaling group is equal to the weight set for the instance type. The default is 1, which means one ECS instance has a capacity of 1.

• PricePerVCpu: Compares prices based on the price per vCPU.

Default value: PricePerUnit.

BalanceMode

String

No

BalancedBestEffort

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

• BalancedBestEffort:

  If resources fail to be created in a zone, the system falls back to other zones to ensure that resources are delivered on a best-effort basis.

• BalancedOnly:

  If resources fail to be created in a zone, the system does not fall back to other zones. The scale-out activity is partially successful. This prevents excessive imbalance of resources across different zones.

Default value: BalancedBestEffort.

AutoRebalance

Boolean

No

false

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: Does not enable automatic rebalancing for the scaling group.

• true: Enables automatic rebalancing for the scaling group. The scaling group automatically detects the capacity in each zone. If the capacity is imbalanced across zones, the scaling group automatically performs a scale-out or scale-in activity to rebalance the capacity.

Default value: false.

RequestId

String

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

The ID of the request.

ScalingGroupId

String

asg-bp14wlu85wrpchm0****

The ID of the scaling group.