| object | The information about the scaling group list. | |
ScalingGroups | array<object> | The information about the scaling groups. | |
| object | | |
VpcId | string | The ID of the virtual private cloud (VPC) in which the scaling group resides. | vpc-bp1vwnn14rqpyiczj**** |
CreationTime | string | The time at which the scaling group was created. | 2014-08-14T10:58Z |
TotalInstanceCount | integer | The total number of Elastic Compute Service (ECS) instances in the scaling group. | 1 |
ScalingGroupName | string | The name of the scaling group. | dyrSuvBOtO1dEdIlIbp**** |
SpotInstancePools | integer | The number of instance types that are specified. Auto Scaling evenly creates preemptible instances of multiple instance types that are provided at the lowest price across the zones of the scaling group. Valid values: 0 to 10. | 5 |
StoppedCapacity | integer | The number of instances that was stopped in Economical Mode in the scaling group. | 1 |
OnDemandPercentageAboveBaseCapacity | integer | 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. | 20 |
ModificationTime | string | The time when the scaling group was modified. | 2014-08-14T10:58Z |
MinSize | integer | The minimum number of ECS instances that must be contained in the scaling group. | 1 |
ScalingGroupId | string | The ID of the scaling group. | asg-bp14wlu85wrpchm0**** |
CompensateWithOnDemand | boolean | Indicates whether Auto Scaling would use pay-as-you-go instances as a backup when unable to create preemptible instances due to price fluctuations or stock shortages when MultiAZPolicy is set to COST_OPTIMIZED. Valid values:
| true |
ScalingPolicy | string | The reclaim mode of the scaling group. Valid values:
- recycle: economical mode
- release: release mode
- forcerelease: forced release mode
For more information, see RemoveInstances . | recycle |
RemovingWaitCapacity | integer | The number of ECS instances that are in the Pending Remove state in the scaling group. | 1 |
ActiveCapacity | integer | The number of ECS instances that are in the In Service state in the scaling group. | 1 |
OnDemandBaseCapacity | integer | 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. | 30 |
ProtectedCapacity | integer | The number of ECS instances that are in the Protected state in the scaling group. | 1 |
HealthCheckType | string | The health check mode of the scaling group. Valid values:
- NONE: Auto Scaling does not perform health checks.
- ECS: Auto Scaling checks the health status of ECS instances in the scaling group.
- LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group 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.
| ECS |
LifecycleState | string | The state of the scaling group. Valid values:
- Active: The scaling group is active. Active scaling groups can receive requests to execute scaling rules and trigger scaling activities.
- Inactive: The scaling group is inactive. Inactive 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 parameter settings of the scaling groups cannot be modified.
| Active |
GroupDeletionProtection | boolean | Indicates whether Deletion Protection is enabled for the scaling group. Valid values:
- true: Deletion Protection is enabled for the scaling group. The scaling group cannot be deleted.
- false: Deletion Protection is disabled for the scaling group.
| true |
ActiveScalingConfigurationId | string | The ID of the active scaling configuration in the scaling group. | asc-bp1et2qekq3ojr33**** |
GroupType | string | The type of the instances that are managed by the scaling group. | ECS |
MultiAZPolicy | string | The scaling policy of the ECS instances in the multi-zone scaling group. Valid values:
-
PRIORITY: ECS instances are created based on the value of VSwitchIds. If Auto Scaling cannot create ECS instances in the zone where the vSwitch of the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch of the next highest priority resides.
-
COST_OPTIMIZED: ECS instances are created based on the unit prices of their vCPUs. Auto Scaling preferentially creates ECS instances whose vCPUs are provided at the lowest price. If preemptible instance types are specified in the scaling configuration, Auto Scaling preferentially creates preemptible instances. You can also specify CompensateWithOnDemand to allow Auto Scaling to create pay-as-you-go instances in the case that preemptible instances cannot be created due to limited stock.
**
Note The COST_OPTIMIZED setting takes effect only when your scaling configuration includes multiple instance types or specifically includes preemptible instance types.
-
BALANCE: ECS instances are evenly distributed across the zones that are specified for the scaling group. If ECS instances become unevenly distributed across the designated zones due to limited instance type availability, you can call the RebalanceInstance operation to rebalance the distribution of the ECS instances.
| PRIORITY |
RemovingCapacity | integer | The number of ECS instances that are being removed from the scaling group. | 0 |
PendingWaitCapacity | integer | The number of ECS instances that are in the Pending Add state in the scaling group. | 1 |
StandbyCapacity | integer | The number of ECS instances that are in the Standby state in the scaling group. | 1 |
CurrentHostName | string |
Note
This parameter is not available for use.
| hostname |
PendingCapacity | integer | The number of ECS instances that are being added to the scaling group and configured. | 0 |
LaunchTemplateId | string | The ID of the launch template that is used by the scaling group. | lt-m5e3ofjr1zn1aw7**** |
TotalCapacity | integer | The total weighted capacity of all ECS instances in the scaling group if Weighted is specified. In other cases, this parameter specifies the total number of ECS instances in the scaling group. | 1 |
DesiredCapacity | integer | The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances. | 5 |
SpotInstanceRemedy | boolean | Indicates whether preemptible instances can be supplemented. If this parameter is set to true, Auto Scaling proactively creates new instances to replace preemptible instances upon receiving a system notification signaling their impending reclamation. | true |
LaunchTemplateVersion | string | The version of the launch template that is used by the scaling group. | Default |
RegionId | string | The region ID of the scaling group. | cn-qingdao |
VSwitchId | string | The vSwitch ID of the scaling group. | vsw-bp1whw2u46cn8zubm**** |
MaxSize | integer | The maximum number of ECS instances that can be contained in the scaling group. | 2 |
DefaultCooldown | integer | The cooldown period of the scaling group. During the cooldown period, Auto Scaling does not execute the scaling activities that are triggered by CloudMonitor event-triggered tasks. | 60 |
VServerGroups | array<object> | The backend vServer groups. | |
| object | | |
LoadBalancerId | string | The ID of the load balancer to which the backend vServer group belongs. | 147b46d767c-cn-qingdao-cm5**** |
VServerGroupAttributes | array<object> | The attributes of the backend vServer group. | |
| object | | |
VServerGroupId | string | The ID of the backend vServer group. | rsp-bp12bjrny**** |
Weight | integer | The weight of the backend vServer group. | 1 |
Port | integer | The port number that is used by the load balancer to provide external services. | 22 |
LaunchTemplateOverrides | array<object> | The information about the instance types that are extended in the launch template. | |
| object | | |
WeightedCapacity | integer | The weight of the instance type. The value of this parameter indicates the capacity of an instance of the specified instance type in the scaling group. A larger weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement. | 4 |
InstanceType | string | The instance type. The instance type that is specified by this parameter overrides the instance type that is specified in the launch template. | ecs.c5.xlarge |
SpotPriceLimit | float | The maximum bid price of the instance type that is specified by LaunchTemplateOverride.InstanceType .
Note
This parameter takes effect only if you specify LaunchTemplateId .
| 0.025 |
AlbServerGroups | array<object> | The information about the Application Load Balancer (ALB) server groups. | |
| object | | |
AlbServerGroupId | string | The ID of the ALB server group. | sgp-ddwb0y0g6y9bjm**** |
Weight | integer | The weight of an ECS instance as a backend server in the ALB server group. | 100 |
Port | integer | The port number used by an ECS instance as a backend server in the ALB server group. | 80 |
ServerGroups | array<object> | The information about the server groups.
Note
You can use this parameter to obtain information about ALB server groups and Network Load Balancer (NLB) server groups associated with your scaling group.
| |
| object | | |
ServerGroupId | string | The ID of the server group. | sgp-i9ouakeaerr***** |
Type | string | The type of the server group. Valid values:
| ALB |
Weight | integer | The weight of an ECS instance as a backend server in the server group. | 100 |
Port | integer | The port number used by an ECS instance as a backend server in the server group. | 80 |
RemovalPolicies | array | The instance removal policies. Valid values:
- OldestInstance: Auto Scaling removes ECS instances that are added at the earliest point in time to the scaling group.
- NewestInstance: Auto Scaling removes ECS instances that are most recently added to the scaling group.
- OldestScalingConfiguration: Auto Scaling removes ECS instances that are created from the earliest scaling configuration.
| |
| string | The instance removal policy. Valid values:
- OldestInstance: Auto Scaling removes ECS instances that are added at the earliest point in time to the scaling group.
- NewestInstance: Auto Scaling removes ECS instances that are most recently added to the scaling group.
- OldestScalingConfiguration: Auto Scaling removes ECS instances that are created from the earliest scaling configuration.
| OldestScalingConfiguration |
DBInstanceIds | array | The IDs of the ApsaraDB RDS instances that are attached to the scaling group. | |
| string | The ID of the ApsaraDB RDS instance that is attached to the scaling group. | rm-bp15556qzebg1**** |
LoadBalancerIds | array | The IDs of the load balancers that are attached to the scaling group. | |
| string | The ID of the load balancer that is attached to the scaling group. | lb-bp19byhscefk3x0li**** |
VSwitchIds | array | The IDs of the vSwitches that are associated with the scaling group. If you specify VSwitchIds, VSwitchId is ignored. | |
| string | The ID of the vSwitch that is associated with the scaling group. If you specify VSwitchIds, VSwitchId is ignored. | vsw-bp1whw2u46cn8zubm**** |
SuspendedProcesses | array | The processes that are suspended. If no process is suspended, null is returned. Valid values:
- ScaleIn: the scale-in process
- ScaleOut: the scale-out process
- HealthCheck: the health check process
- AlarmNotification: the process of executing an event-triggered task
- ScheduledAction: the process of executing a scheduled task
| |
| string | The process that is suspended. If no process is suspended, null is returned. Valid values:
- ScaleIn: the scale-in process
- ScaleOut: the scale-out process
- HealthCheck: the health check process
- AlarmNotification: the process of executing an event-triggered task
- ScheduledAction: the process of executing a scheduled task
| ScaleIn |
SystemSuspended | boolean | 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 if the scaling activities failed for more than seven consecutive days in the scaling group. You must modify the scaling group or scaling configuration to resume the execution of the scaling activities.
- false: Auto Scaling does not stop executing scaling activities in the scaling group.
| true |
IsElasticStrengthInAlarm | boolean |
Note
This parameter is not available for use.
| false |
MonitorGroupId | string | The ID of the CloudMonitor application group that is associated with the scaling group. | 1497**** |
AzBalance | boolean | Indicates whether instances in the scaling group are evenly distributed across the specified zones. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE . Valid values:
| false |
AllocationStrategy | string | The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create the required number of instances. You can apply the policy to pay-as-you-go instances and preemptible instances. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE . Valid values:
- priority: Auto Scaling adheres to the predefined instance type sequence to create the required number of instances.
- lowestPrice: Auto Scaling selects instance types with the most economical vCPU pricing to create the required number of instances.
| priority |
SpotAllocationStrategy | string | The allocation policy of preemptible instances. This parameter indicates the manner in 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 adheres to the predefined instance type sequence to create the required number of preemptible instances.
- lowestPrice: Auto Scaling selects instance types with the most economical vCPU pricing to create the required number of preemptible instances.
Default value: priority. | lowestPrice |
MaxInstanceLifetime | integer | The maximum life span of an instance in the scaling group. Unit: seconds.
Valid values: 0 or from 86400 to Integer.maxValue . A value of 0 for MaxInstanceLifetime indicates that any previously set limit has been removed, effectively disabling the maximum instance lifetime constraint.
Default value: null.
Note
This parameter is not supported by scaling groups of the Elastic Container Instance type and scaling groups whose ScalingPolicy is set to Recycle.
| null |
CustomPolicyARN | string | The Alibaba Cloud Resource Name (ARN) of the function that is specified in the custom scale-in policy. This parameter takes effect only if you set the first value of RemovalPolicies to CustomPolicy. | acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name |
InitCapacity | integer | The number of instances that are initialized before they are actually added into the scaling group. | 0 |
ResourceGroupId | string | The ID of the resource group to which the scaling group belongs. | rg-123**** |
LoadBalancerConfigs | array<object> | The load balancer configurations. | |
| object | | |
LoadBalancerId | string | The ID of the CLB (formerly known as Server Load Balancer or SLB) instance. | lb-2zep8alpq5zq1a2xwyxxx |
Weight | integer | The weight of an ECS instance as a backend server in the CLB server group. 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 of an ECS instance to 0, no access requests are forwarded to the ECS instance. Valid values: 0 to 100. | 10 |
EnableDesiredCapacity | boolean | Indicates whether the Expected Number of Instances feature is enabled. Valid values:
| false |
Tags | array<object> | The tags of the scaling group. | |
| object | | |
TagKey | string | The tag key of the scaling group. | Department |
TagValue | string | The tag value of the scaling group. | Finance |
Propagate | boolean | Indicates whether the tags of the scaling group can be propagated to instances. Valid values:
- true: The tags of the scaling group can be propagated to only instances that are newly created.
- false: The tags of the scaling group cannot be propagated to instances.
Default value: false. | false |
HealthCheckTypes | array | The health check modes of the scaling group. Valid values:
- NONE: Auto Scaling does not perform health checks in the scaling group.
- ECS: Auto Scaling checks the health status of ECS instances in the scaling group.
- LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group 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.
| |
| string | The health check mode of the scaling group. Valid values:
- NONE: Auto Scaling does not perform health checks in the scaling group.
- ECS: Auto Scaling checks the health status of ECS instances in the scaling group.
- LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group 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.
| ECS |
DBInstances | array<object> | The databases attached to the scaling group. | |
| object | | |
DBInstanceId | string | | rm-m5eqju85s45mu0***
|
Type | string | The type of the database. Valid values:
| RDS |
SecurityGroupIds | array | The IDs of the security groups added to the security group whitelist of the attached database. | |
| string | The ID of the security group added to the security group whitelist of the attached database.
If the value of RemoveSecurityGroup in the DetachDBInstances operation is set to true , the security groups specified by this parameter are removed from the security group whitelist of the attached database. | sg-uf65zt66cf2a0q47*** |