Auto Scaling：DescribeScalingGroups

VpcId

String

vpc-bp1vwnn14rqpyiczj****

The ID of the virtual private cloud (VPC) in which the scaling group resides.

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. Auto Scaling creates preemptible instances of multiple instance types that are provided at the lowest price. Valid values: 0 to 10.

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

StoppedCapacity

Integer

1

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

OnDemandPercentageAboveBaseCapacity

Integer

20

The percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances is reached. OnDemandBaseCapacity specifies the minimum number of pay-as-you-go instances that must be contained in the scaling group. Valid values: 0 to 100.

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

ModificationTime

String

2014-08-14T10:58Z

The time when the scaling group was last modified.

MinSize

Integer

1

The lower limit of the number of ECS instances in the scaling group.

ScalingGroupId

String

asg-bp14wlu85wrpchm0****

The ID of the scaling group.

CompensateWithOnDemand

Boolean

true

Indicates whether pay-as-you-go instances can be automatically created 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 MultiAZPolicy to COST_OPTIMIZED. Valid values:

• true

• false

ScalingPolicy

String

recycle

The instance reclaim mode of the scaling group. Valid values:

• recycle: the economical mode.

• release: the release mode.

• forcerelease: the forced release mode.

For information about how to remove instances, 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 in the In Service state in the scaling group.

OnDemandBaseCapacity

Integer

30

The lower limit of the number of pay-as-you-go instances in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances in the scaling group is less than the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances.

If you set MultiAZPolicy to COMPOSABLE, the default value 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 modes of the scaling group. Valid values:

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

• ECS: Auto Scaling checks the health status of instances in the scaling group. If you want to enable instance health check, you can set the value to ECS, regardless of whether the scaling group is of ECS type or Elastic Container Instance type.

• LOAD_BALANCER: Auto Scaling checks the health status of ECS instances based on the health check results of load balancers. The health check results of Classic Load Balancer (CLB) instances are not supported as the health check basis for instances in the scaling group.

LifecycleState

String

Active

The status of the scaling group. Valid values:

• Active: The scaling group is in the Enabled state. Enabled scaling groups can receive requests to execute scaling rules and trigger scaling events.

• Inactive: The scaling group is in the Disabled state. Disabled scaling groups cannot receive requests to execute scaling rules.

• Deleting: The scaling group is being deleted. Scaling groups that are being deleted cannot receive requests to execute scaling rules, and the parameters of the scaling groups cannot be modified.

GroupDeletionProtection

Boolean

true

Indicates whether the Deletion Protection feature is enabled for the scaling group. Valid values:

• true: The Deletion Protection feature is enabled for the scaling group. The scaling group cannot be deleted.

• false: The Deletion Protection feature is disabled for the scaling group.

ActiveScalingConfigurationId

String

asc-bp1et2qekq3ojr33****

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

GroupType

String

ECS

The type of the instances in the scaling group.

MultiAZPolicy

String

PRIORITY

The scaling policy of the multi-zone scaling group of the ECS type. Valid values:

• PRIORITY: ECS instances are scaled based on the value of VSwitchIds.N. If Auto Scaling fails to scale out ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling scales out ECS instances in the zone where the vSwitch that has the next highest priority resides.

• COST_OPTIMIZED: ECS instances are created based on the unit price of vCPUs. Auto Scaling preferentially creates ECS instances whose vCPUs have the lowest price. Auto Scaling preferentially creates preemptible instances if preemptible instance types are specified in the scaling configuration. You can use CompensateWithOnDemand to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.

  Note

  COST_OPTIMIZED is valid if you specify multiple instance types or at least one preemptible instance type.

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

• COMPOSABLE: You can combine the preceding policies based on your business requirements.

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 and still being configured.

LaunchTemplateId

String

lt-m5e3ofjr1zn1aw7****

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

TotalCapacity

Integer

1

The total weighted capacity of all ECS instances in the scaling group if you specified WeightedCapacity. In other cases, the value of this parameter indicates the total number of ECS instances in the scaling group.

DesiredCapacity

Integer

5

The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances that you specified.

SpotInstanceRemedy

Boolean

true

Indicates whether supplementation of preemptible instances is enabled. If this parameter is set to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives a system message indicating that the preemptible instance is to be reclaimed.

LaunchTemplateVersion

String

Default

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

RegionId

String

cn-qingdao

The region ID of the scaling group.

VSwitchId

String

vsw-bp1whw2u46cn8zubm****

The vSwitch ID of the scaling group.

MaxSize

Integer

2

The upper limit of the number of ECS instances in the scaling group.

DefaultCooldown

Integer

60

The default cooldown period of the scaling group. During the cooldown period, Auto Scaling does not execute scaling operations that are triggered by CloudMonitor event-triggered tasks.

RemovalPolicies

Array of String

OldestScalingConfiguration

The scale-in policies. Valid values:

• OldestInstance: ECS instances that are created at the earliest point in time are removed.

• NewestInstance: ECS instances that are created at the most recent point in time are removed.

• OldestScalingConfiguration: ECS instances that are created based on the earliest scaling configuration are removed.

• CustomPolicy: ECS instances are removed based on the custom scale-in policy (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 IDs of the load balancers that are associated with the scaling group.

VSwitchIds

Array of String

vsw-bp1whw2u46cn8zubm****

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

SuspendedProcesses

Array of String

ScaleIn

The suspended process. If no process is suspended, null is returned. Valid values:

• ScaleIn: scale-in processes.

• ScaleOut: scale-out processes.

• HealthCheck: health check processes.

• AlarmNotification: event-triggered task processes.

• ScheduledAction: scheduled task processes.

SystemSuspended

Boolean

true

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

• true: If a scaling operation fails for more than seven consecutive days, Auto Scaling stops executing the scaling operation in the scaling group. In this case, you must modify the scaling group or the scaling configuration to resume the execution of the scaling operation.

• false: Auto Scaling does not stop executing the scaling operation, regardless of its execution result.

MonitorGroupId

String

1497****

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

AzBalance

Boolean

false

Indicates whether instances in the scaling group are evenly distributed across multiple zones. Valid values:

• true

• false

  Note

  This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE.

AllocationStrategy

String

priority

The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create instances. The allocation policy applies to pay-as-you-go and preemptible instances. Valid values:

• priority: Auto Scaling selects instance types based on their 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.

  Note

  This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE.

SpotAllocationStrategy

String

lowestPrice

The allocation policy of preemptible instances. This parameter indicates the method by which Auto Scaling selects instance types to create the required number of preemptible instances. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on their 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.

MaxInstanceLifetime

Integer

null

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

Valid values: 0 or from 86400 to the value of Integer.maxValue. A value of 0 indicates that the instance has an unlimited life span in the scaling group.

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 (Function). This parameter is returned only if you specify CustomPolicy as the first step of the scale-in policy.

InitCapacity

Integer

0

The number of instances that are in the Initialized state and ready to be scaled out 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 feature is enabled. Valid values:

• true: The Expected Number of Instances feature is enabled. In this case, the response includes information about the expected number of instances.

• false: The Expected Number of Instances feature is disabled. In this case, the response does not include information about the expected number of instances.

HealthCheckTypes

Array of String

ECS

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

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

• ECS: Auto Scaling checks the health status of instances in the scaling group. If you want to enable instance health check, you can set the value to ECS, regardless of whether the scaling group is of ECS type or Elastic Container Instance type.

• LOAD_BALANCER: Auto Scaling checks the health status of ECS instances based on the health check results of load balancers. The health check results of CLB instances are not supported as the health check basis for instances in the scaling group.

SpotCapacity

Integer

0

The number of preemptible instances in the scaling group.

StopInstanceTimeout

Integer

60

The period of time that is required by ECS instances to enter the Stopped state during the scale-in process. Unit: seconds.