Auto Scaling:DescribeScalingGroups

VpcId

String

vpc-bp1vwnn14rqpyiczj****

The ID of the virtual private cloud (VPC) to which the scaling group belongs.

CreationTime

String

2014-08-14T10:58Z

The time when the scaling group was created.

TotalInstanceCount

Integer

1

The total number of ECS instances in the scaling group.

ScalingGroupName

String

dyrSuvBOtO1dEdIlIbp****

The name of the scaling group.

SpotInstancePools

Integer

5

The number of instance types that you can specify. Auto Scaling creates spot instances of multiple instance types that are provided at the lowest cost in a balanced manner. Valid values: 0 to 10.

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

StoppedCapacity

Integer

1

The number of instances that are in the Economical Mode in the scaling group.

OnDemandPercentageAboveBaseCapacity

Integer

20

The percentage of on-demand instances among the instances that are created in excess of the number specified by OnDemandBaseCapacity. This parameter takes effect after the number of on-demand instances reaches the value of OnDemandBaseCapacity. Valid values: 0 to 100.

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

ModificationTime

String

2014-08-14T10:58Z

Last modified.

MinSize

Integer

1

The minimum number of ECS instances in the scaling group.

ScalingGroupId

String

asg-bp14wlu85wrpchm0****

The ID of the scaling group.

CompensateWithOnDemand

Boolean

true

Indicates whether to automatically create 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 and inventory. This parameter is valid only when MultiAZPolicy is set to COST_OPTIMIZED. Valid values:

• true: Pay-as-you-go instances are automatically created.

• false: Pay-as-you-go instances are not automatically created.

ScalingPolicy

String

recycle

The reclaim mode of the scaling group. Valid values:

• recycle: economical mode.

• release: release mode.

• forcerelease: forced release mode.

For more information about the actions on instances that are removed from a scaling group, see RemoveInstances.

RemovingWaitCapacity

Integer

1

The number of ECS instances that are in the Pending Remove state in the scaling group.

ActiveCapacity

Integer

1

The number of ECS instances that are successfully added to the scaling group and running.

OnDemandBaseCapacity

Integer

30

The minimum number of on-demand instances that must be included in the scaling group. Valid values: 0 to 1000. If the number of on-demand instances in the scaling group is less than this value, Auto Scaling preferentially creates on-demand instances.

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

ProtectedCapacity

Integer

1

The number of ECS instances that are in the Protected state in the scaling group.

HealthCheckType

String

ECS

The health check mode 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 can be used to enable health checks for both ECS and ECI scaling groups.

• LOAD_BALANCER: The health status of instances is determined based on the health check results of the load balancer. Health check results of Classic Load Balancer (CLB) instances are not supported.

LifecycleState

String

Active

The state of the scaling group. Valid values:

• Active: The scaling group is active. An active scaling group can receive requests to execute scaling rules and trigger scaling activities.

• Inactive: The scaling group is inactive. An inactive scaling group does not receive requests to execute scaling rules.

• Deleting: The scaling group is being deleted. A scaling group in the Deleting state does not receive requests to execute scaling rules, and its parameters cannot be modified.

GroupDeletionProtection

Boolean

true

Indicates whether deletion protection is enabled for the scaling group. Valid values:

• true: Deletion protection is enabled. The scaling group cannot be deleted.

• false: Deletion protection is disabled.

ActiveScalingConfigurationId

String

asc-bp1et2qekq3ojr33****

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

GroupType

String

ECS

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

MultiAZPolicy

String

PRIORITY

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

• PRIORITY: Scales instances based on the vSwitch priority. The vSwitch priority is specified by the VSwitchIds.N parameter. Auto Scaling scales instances in the zone of the vSwitch that has the highest priority. If the scaling fails, Auto Scaling scales instances in the zone of the vSwitch that has the next highest priority.

• COST_OPTIMIZED: Creates instances based on the vCPU unit price from lowest to highest. When the scaling configuration is configured with multiple instance types and the preemptible billing method is used, the system prioritizes the creation of preemptible instances. You can also use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to reasons such as inventory shortages.

  Note

  The COST_OPTIMIZED policy is valid only when multiple instance types are specified in the scaling configuration or when preemptible instances are selected.

• BALANCE: Distributes ECS instances evenly across the specified zones in the scaling group. If the distribution of ECS instances becomes uneven due to inventory shortages, you can call the RebalanceInstance operation to rebalance the resources.

• COMPOSABLE: A composite policy that lets you combine the preceding policies as needed to scale ECS instances in a multi-zone scaling group.

RemovingCapacity

Integer

0

The number of ECS instances that are being removed from the scaling group.

PendingWaitCapacity

Integer

1

The number of ECS instances that are in the Pending Add state in the scaling group.

StandbyCapacity

Integer

1

The number of instances that are in the Standby state in the scaling group.

PendingCapacity

Integer

0

The number of ECS instances that are being added to the scaling group but have not completed their configurations.

LaunchTemplateId

String

lt-m5e3ofjr1zn1aw7****

The ID of the launch template that is used by the scaling group.

TotalCapacity

Integer

1

If instance type weights are specified for the scaling group, this parameter indicates the total weighted capacity of all ECS instances in the scaling group. Otherwise, this parameter indicates the total number of all ECS instances in the scaling group.

DesiredCapacity

Integer

5

The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the number of ECS instances at the expected value.

SpotInstanceRemedy

Boolean

true

Indicates whether to supplement spot instances. If this feature is enabled, Auto Scaling attempts to create a new instance to replace a spot instance when the spot instance is reclaimed.

LaunchTemplateVersion

String

Default

The version of the launch template that is used by the scaling group.

RegionId

String

cn-qingdao

The ID of the region where the scaling group is located.

VSwitchId

String

vsw-bp1whw2u46cn8zubm****

The ID of the vSwitch that is associated with the scaling group.

MaxSize

Integer

2

The maximum number of ECS instances in the scaling group.

DefaultCooldown

Integer

60

The default cooldown time of the scaling group. During the cooldown time, the scaling group does not execute other scaling activities. This parameter is valid only for scaling activities that are triggered by event-triggered tasks created in CloudMonitor.

RemovalPolicies

Array of String

OldestScalingConfiguration

The policies for removing ECS instances from the scaling group. Valid values:

• OldestInstance: Removes the ECS instance that was created the earliest.

• NewestInstance: Removes the ECS instance that was created most recently.

• 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 that is specified by a Function Compute function.

DBInstanceIds

Array of String

rm-bp15556qzebg1****

The IDs of the ApsaraDB RDS instances that are associated with the scaling group.

LoadBalancerIds

Array of String

lb-bp19byhscefk3x0li****

The list of IDs of the SLB instances that are associated with the scaling group.

VSwitchIds

Array of String

vsw-bp1whw2u46cn8zubm****

The collection of IDs of the vSwitches that are associated with the scaling group. If you specify the VSwitchIds parameter, the VSwitchId parameter is ignored.

SuspendedProcesses

Array of String

ScaleIn

The suspended processes. If no process is suspended, an empty value is returned. Valid values:

• ScaleIn: the scale-in process.

• ScaleOut: the scale-out process.

• HealthCheck: the health check process.

• AlarmNotification: the event-triggered task process.

• ScheduledAction: the scheduled task process.

SystemSuspended

Boolean

true

Indicates whether Auto Scaling stops executing scaling activities in the scaling group. Valid values:

• true: Auto Scaling stops executing scaling activities in the scaling group because scaling activities have failed for more than seven consecutive days. You must modify the scaling group or scaling configuration to resume the scaling activities.

• false: Auto Scaling executes scaling activities in the scaling group.

MonitorGroupId

String

1497****

The ID of the CloudMonitor application group that is associated with the scaling group.

AzBalance

Boolean

false

Indicates whether the capacity of the scaling group is evenly distributed across multiple zones. 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.

  Note

  This parameter is valid only when the MultiAZPolicy parameter is set to COMPOSABLE.

AllocationStrategy

String

priority

The capacity allocation policy. This policy determines how Auto Scaling selects available instance types to meet the capacity requirement. The capacity allocation policy is valid for both on-demand and spot instances. Valid values:

• priority: Creates instances in the order of the configured instance types.

• lowestPrice: Creates instances based on the unit price of vCPUs from lowest to highest.

  Note

  This parameter is valid only when the MultiAZPolicy parameter is set to COMPOSABLE.

SpotAllocationStrategy

String

lowestPrice

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

MaxInstanceLifetime

Integer

null

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

Valid values: 0 or a value in the range of [86400, Integer.maxValue]. A value of 0 clears the previously set MaxInstanceLifetime value, which means that the instance has an unlimited lifetime.

Default value: null.

CustomPolicyARN

String

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

The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy that is specified by a Function Compute function. This parameter is valid only when the first removal policy is set to CustomPolicy.

InitCapacity

Integer

0

The number of instances that are in the initialization state before a scale-out activity in the scaling group.

ResourceGroupId

String

rg-123****

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

EnableDesiredCapacity

Boolean

false

Indicates whether the expected number of instances is enabled. Valid values:

• true: The expected number of instances is enabled. The response returns information about the expected number of instances.

• false: The expected number of instances is not enabled. The response does not return information about the expected number of instances.

HealthCheckTypes

Array of String

ECS

The health check mode 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 can be used to enable health checks for both ECS and ECI scaling groups.

• LOAD_BALANCER: The health status of instances is determined based on the health check results of the load balancer. Health check results of Classic Load Balancer (CLB) instances are not supported.

SpotCapacity

Integer

0

The number of spot instances in the scaling group.

StopInstanceTimeout

Integer

60

The timeout period for an ECS instance to enter the Stopped state during a scale-in activity. Unit: seconds.

BalanceMode

String

BalancedBestEffort

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

• BalancedBestEffort:

  If resources cannot be created in a zone, the system attempts to create them in other zones to ensure resource delivery.

• BalancedOnly:

  If resources cannot be created in a zone, the system does not attempt to create them in other zones. The scale-out activity is partially successful. This prevents resource imbalance across zones.

AutoRebalance

Boolean

false

Indicates whether to enable automatic rebalancing for the scaling group. This parameter is valid only if you enable zone balancing for the scaling group and set BalanceMode to BalancedOnly. Valid values:

• false: Automatic rebalancing is disabled.

• true: Automatic rebalancing is enabled. Auto Scaling automatically checks the capacity in each zone. If the capacity is imbalanced, it automatically performs scale-out or scale-in activities to rebalance the capacity across zones.