DescribeScalingGroups - Auto Scaling - Alibaba Cloud Documentation Center

Queries scaling groups. You can call the DescribeScalingGroups operation to query the basic information about, number of instances in, and scaling configuration of your scaling group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ess:DescribeScalingGroups	Read	ScalingGroup acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object	The scaling groups.
ScalingGroups	object []	The information about the scaling groups.
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 specified instance types. 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 are 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 can create pay-as-you-go instances to supplement preemptible instances in the case that preemptilble instances cannot be created due to price-related factors or insufficient inventory when MultiAZPolicy is set to COST_OPTIMIZED. Valid values: true false	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 in the scaling group 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 check the health status of instances 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 Classic Load Balancer (CLB) instances are not supported as the health check basis for instances in the scaling group.	ECS
LifecycleState	string	The lifecycle 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 activities. 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 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 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 insufficient inventory of preemptible instance types. Note** The COST_OPTIMIZED setting takes effect only if you specified multiple instance types or preemptible instance types in your scaling configuration. BALANCE: ECS instances are evenly distributed across the zones that are specified for the scaling group. If ECS instance are unevenly distributed across the specified zones due to insufficient inventory of instance types, 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 creates an instance to replace a preemptible instance when Auto Scaling receives the system message which indicates that the preemptible instance is to be reclaimed.	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	object []	The backend vServer groups.
LoadBalancerId	string	The ID of the load balancer to which the backend vServer group belongs.	147b46d767c-cn-qingdao-cm5****
VServerGroupAttributes	object []	The attributes of the backend vServer group.
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	object []	The information about the instance types that are extended in the launch template.
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 higher 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	object []	The information about the Application Load Balancer (ALB) server groups.
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	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.
ServerGroupId	string	The ID of the server group.	sgp-i9ouakeaerr*****
Type	string	The type of the server group. Valid values: ALB: ALB server group NLB: NLB server group	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 based on 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 based on the earliest scaling configuration.	OldestScalingConfiguration
DBInstanceIds	array	The IDs of the ApsaraDB RDS instances that are associated with the scaling group.
	string	The ID of the ApsaraDB RDS instance that is associated with the scaling group.	rm-bp15556qzebg1****
LoadBalancerIds	array	The IDs of the load balancers that are associated with the scaling group.
	string	The ID of the load balancer that is associated with 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: scale-in ScaleOut: scale-out HealthCheck: health check AlarmNotification: event-triggered task ScheduledAction: scheduled task
	string	The process that is suspended. If no process is suspended, null is returned. Valid values: ScaleIn: scale-in ScaleOut: scale-out HealthCheck: health check AlarmNotification: event-triggered task ScheduledAction: 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: true false	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 selects instance types based on the specified order 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.	priority
SpotAllocationStrategy	string	The allocation policy of preemptible instances. You can use this parameter to individually specify the allocation policy for preemptible instances. This parameter takes effect only if you set `MultiAZPolicy` to `COMPOSABLE`. Valid values: priority: Auto Scaling selects instance types based on the specified order 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.	lowestPrice
MaxInstanceLifetime	integer	The maximum life span of an ECS instance in the scaling group. Unit: seconds. Valid values: 0 or from 86400 to `Integer.maxValue`. A value of 0 indicates that the ECS instance has an unlimited life span in the scaling group. 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 in the Initialized state and ready to be scaled out in the scaling group.	0
ResourceGroupId	string	The ID of the resource group to which the scaling group belongs.	rg-123****
LoadBalancerConfigs	object []	The load balancer configurations.
LoadBalancerId	string	The ID of the Classic Load Balancer (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: true false	false
Tags	object []	The tags of the scaling group.
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 check the health status of instances 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 check the health status of instances 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

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "ScalingGroups": [
    {
      "VpcId": "vpc-bp1vwnn14rqpyiczj****",
      "CreationTime": "2014-08-14T10:58Z",
      "TotalInstanceCount": 1,
      "ScalingGroupName": "dyrSuvBOtO1dEdIlIbp****",
      "SpotInstancePools": 5,
      "StoppedCapacity": 1,
      "OnDemandPercentageAboveBaseCapacity": 20,
      "ModificationTime": "2014-08-14T10:58Z",
      "MinSize": 1,
      "ScalingGroupId": "asg-bp14wlu85wrpchm0****",
      "CompensateWithOnDemand": true,
      "ScalingPolicy": "recycle",
      "RemovingWaitCapacity": 1,
      "ActiveCapacity": 1,
      "OnDemandBaseCapacity": 30,
      "ProtectedCapacity": 1,
      "HealthCheckType": "ECS",
      "LifecycleState": "Active",
      "GroupDeletionProtection": true,
      "ActiveScalingConfigurationId": "asc-bp1et2qekq3ojr33****",
      "GroupType": "ECS",
      "MultiAZPolicy": "PRIORITY",
      "RemovingCapacity": 0,
      "PendingWaitCapacity": 1,
      "StandbyCapacity": 1,
      "CurrentHostName": "hostname",
      "PendingCapacity": 0,
      "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
      "TotalCapacity": 1,
      "DesiredCapacity": 5,
      "SpotInstanceRemedy": true,
      "LaunchTemplateVersion": "Default",
      "RegionId": "cn-qingdao",
      "VSwitchId": "vsw-bp1whw2u46cn8zubm****",
      "MaxSize": 2,
      "DefaultCooldown": 60,
      "VServerGroups": [
        {
          "LoadBalancerId": "147b46d767c-cn-qingdao-cm5****",
          "VServerGroupAttributes": [
            {
              "VServerGroupId": "rsp-bp12bjrny****",
              "Weight": 1,
              "Port": 22
            }
          ]
        }
      ],
      "LaunchTemplateOverrides": [
        {
          "WeightedCapacity": 4,
          "InstanceType": "ecs.c5.xlarge",
          "SpotPriceLimit": 0.025
        }
      ],
      "AlbServerGroups": [
        {
          "AlbServerGroupId": "sgp-ddwb0y0g6y9bjm****",
          "Weight": 100,
          "Port": 80
        }
      ],
      "ServerGroups": [
        {
          "ServerGroupId": "sgp-i9ouakeaerr*****",
          "Type": "ALB",
          "Weight": 100,
          "Port": 80
        }
      ],
      "RemovalPolicies": [
        "OldestScalingConfiguration"
      ],
      "DBInstanceIds": [
        "rm-bp15556qzebg1****"
      ],
      "LoadBalancerIds": [
        "lb-bp19byhscefk3x0li****"
      ],
      "VSwitchIds": [
        "vsw-bp1whw2u46cn8zubm****"
      ],
      "SuspendedProcesses": [
        "ScaleIn"
      ],
      "SystemSuspended": true,
      "IsElasticStrengthInAlarm": false,
      "MonitorGroupId": "1497****",
      "AzBalance": false,
      "AllocationStrategy": "priority",
      "SpotAllocationStrategy": "lowestPrice",
      "MaxInstanceLifetime": 0,
      "CustomPolicyARN": "acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name",
      "InitCapacity": 0,
      "ResourceGroupId": "rg-123****",
      "LoadBalancerConfigs": [
        {
          "LoadBalancerId": "lb-2zep8alpq5zq1a2xwyxxx",
          "Weight": 10
        }
      ],
      "EnableDesiredCapacity": false,
      "Tags": [
        {
          "TagKey": "Department",
          "TagValue": "Finance",
          "Propagate": false
        }
      ],
      "HealthCheckTypes": [
        "ECS"
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-02-01

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-11-14

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-10-09

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-09-19

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tags

2023-06-27

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-03-30

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2022-12-22

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.