Use DescribeScalingInstances to query instances in a scaling group - Auto Scaling - Alibaba Cloud - Auto Scaling

Queries the list of ECS instances in a scaling group and instance information by scaling group ID, including the total number of running spot instances, total number of ECS instances, warmup state of ECS instances, and lifecycle state in the current scaling group. Also supports filtering ECS instances by health status, lifecycle state, and creation type.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:DescribeScalingInstances

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group.	cn-hangzhou
ScalingGroupId	string	No	The ID of the scaling group.	asg-bp1igpak5ft1flyp****
ScalingConfigurationId	string	No	The ID of the associated scaling configuration.	asc-bp1i65jd06v04vdh****
HealthStatus	string	No	The health check status of the ECS instance in the scaling group. ECS instances that are not in the Running instance status are considered unhealthy. Valid values: Healthy: The ECS instance is healthy. Unhealthy: The ECS instance is unhealthy. Auto Scaling automatically removes unhealthy ECS instances from the scaling group and releases ECS instances created through automatic creation. Whether manually added ECS instances are released depends on their managed state. If the instance lifecycle is not managed by the scaling group, the instance is only removed but not released. If the instance lifecycle is managed by the scaling group, the instance is removed and released. Note Ensure that your account has sufficient active quota. If your account has an overdue payment, all pay-as-you-go ECS instances (including pay-as-you-go instances and spot instances) are stopped or even released. For information about how the instance status of ECS instances in a scaling group changes after an overdue payment occurs, see Overdue payments.	Healthy
LifecycleState	string	No	The lifecycle state of the ECS instance in the scaling group. Valid values: InService: The ECS instance has been successfully added to the scaling group and provides services as Normal. Pending: The ECS instance is being added to the scaling group. During this procedure, the ECS instance is added to the backend server groups of the associated load balancing instances and to the access whitelists of the associated ApsaraDB RDS instances. Pending:Wait: The ECS instance is waiting to be added to the scaling group. If a lifecycle hook that applies to scale-out activities is created for the scaling group, the ECS instance is suspended during the adding process and waits for the lifecycle hook timeout to end. Protected: The ECS instance is protected. The ECS instance provides services as Normal, but Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage it. Standby: The ECS instance is in the standby state. The ECS instance does not provide services, the weight of SLB backend server is set to zero, and Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage it. Stopped: The ECS instance is stopped and does not provide services. Removing: The ECS instance is being removed from the scaling group. During this procedure, the ECS instance is removed from the backend server groups of the associated load balancing instances and from the access whitelists of the associated ApsaraDB RDS instances. Removing:Wait: The ECS instance is waiting to be removed from the scaling group. If a lifecycle hook that applies to scale-down activities is created for the scaling group, the ECS instance is suspended during the removing process and waits for the lifecycle hook timeout to end.	InService
CreationType	string	No	The method used to create the instance in the scaling group. Valid values: AutoCreated: The ECS instance is created through automatic creation by Auto Scaling based on the instance configuration source. Attached: The ECS instance is not created by Auto Scaling but manually added to the scaling group. Managed: The managed instance is not created by Auto Scaling but manually added to the scaling group.	AutoCreated
PageNumber	integer	No	The page number of the ECS instance list. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page for the paged query. Maximum value: 100. Settings for paging apply to each page. Default value: 10.	10
ScalingActivityId	string	No	The ID of the scaling activity.	asa-bp1c9djwrgxjyk31****
InstanceIds	array	No	The IDs of the ECS instances. Invalid InstanceId values are ignored in the query results, and no error is returned.
	string	No	The IDs of the ECS instances. Invalid InstanceId values are ignored in the query results, and no error is returned.	i-bp109k5j3dum1ce6****
CreationTypes	array	No	The methods used to create instances in the scaling group. You can specify only one of this parameter and CreationType.
	string	No	The method used to create instances in the scaling group. Valid values: AutoCreated, Attached, and Managed.	AutoCreated
LifecycleStates	array	No	The lifecycle states of ECS instances in the scaling group. You can specify only one of this parameter and LifecycleState. We recommend that you use this parameter.
	string	No	The lifecycle state of the ECS instance in the scaling group. Valid values: InService: The ECS instance has been successfully added to the scaling group and provides services as Normal. Pending: The ECS instance is being added to the scaling group. During this procedure, the ECS instance is added to the backend server groups of the associated load balancing instances and to the access whitelists of the associated ApsaraDB RDS instances. Pending:Wait: The ECS instance is waiting to be added to the scaling group. If a lifecycle hook that applies to scale-out activities is created for the scaling group, the ECS instance is suspended during the adding process and waits for the lifecycle hook timeout to end. Protected: The ECS instance is protected. The ECS instance provides services as Normal, but Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage it. Standby: The ECS instance is in the standby state. The ECS instance does not provide services, the weight of SLB backend server is set to zero, and Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage it. Stopped: The ECS instance is stopped and does not provide services. Removing: The ECS instance is being removed from the scaling group. During this procedure, the ECS instance is removed from the backend server groups of the associated load balancing instances and from the access whitelists of the associated ApsaraDB RDS instances. Removing:Wait: The ECS instance is waiting to be removed from the scaling group. If a lifecycle hook that applies to scale-down activities is created for the scaling group, the ECS instance is suspended during the removing process and waits for the lifecycle hook timeout to end.	InService

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B13527BF-1FBD-4334-A512-20F5E9D3****
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The current page number.	1
TotalSpotCount	integer	The total number of running spot instances in the current scaling group.	4
TotalCount	integer	The total number of ECS instances.	1
ScalingInstances	array<object>	The collection of ECS instance information.
	object	The collection of ECS instance information.
CreationTime	string	The time when the ECS instance was added to the scaling group. The value is accurate to the minute.	2020-05-18T03:11Z
LoadBalancerWeight	integer	The load balancing instance weight. Note This parameter is deprecated and is not recommended.	50
LaunchTemplateId	string	The ID of the launch template.	lt-m5e3ofjr1zn1aw7****
InstanceId	string	The ID of the ECS instance.	i-bp109k5j3dum1ce6****
SpotStrategy	string	The preemption policy of the spot instance. Valid values: SpotWithPriceLimit: The spot instance has a maximum price limit. SpotAsPriceGo: The system automatically bids at the current market price.	SpotWithPriceLimit
LaunchTemplateVersion	string	The version of the launch template.	1
HealthStatus	string	The health check status of the ECS instance in the scaling group. ECS instances that are not in the Running instance status are considered unhealthy. Valid values: Healthy: The ECS instance is healthy. Unhealthy: The ECS instance is unhealthy. Auto Scaling automatically removes unhealthy ECS instances from the scaling group and releases ECS instances created through automatic creation. Whether manually added ECS instances are released depends on their managed state. If the instance lifecycle is not managed by the scaling group, the instance is only removed but not released. If the instance lifecycle is managed by the scaling group, the instance is removed and released. Note Ensure that your account has sufficient active quota. If your account has an overdue payment, all pay-as-you-go ECS instances (including pay-as-you-go instances and spot instances) are stopped or even released. For information about how the instance status of ECS instances in a scaling group changes after an overdue payment occurs, see Overdue payments.	Healthy
ScalingGroupId	string	The ID of the scaling group to which the instance belongs.	asg-bp1igpak5ft1flyp****
WarmupState	string	The warmup state of the ECS instance. Valid values: NoNeedWarmup: No warmup is required. WaitingForInstanceWarmup: The instance is waiting for warmup to complete. InstanceWarmupFinish: Warmup is complete.	NoNeedWarmup
LifecycleState	string	The lifecycle state of the ECS instance in the scaling group. Valid values: InService: The ECS instance has been successfully added to the scaling group and provides services as Normal. Pending: The ECS instance is being added to the scaling group. During this procedure, the ECS instance is added to the backend server groups of the associated load balancing instances and to the access whitelists of the associated ApsaraDB RDS instances. Pending:Wait: The ECS instance is waiting to be added to the scaling group. If a lifecycle hook that applies to scale-out activities is created for the scaling group, the ECS instance is suspended during the adding process and waits for the lifecycle hook timeout to end. Protected: The ECS instance is protected. The ECS instance provides services as Normal, but Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage it. Standby: The ECS instance is in the standby state. The ECS instance does not provide services, the weight of SLB backend server is set to zero, and Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage it. Stopped: The ECS instance is stopped and does not provide services. Removing: The ECS instance is being removed from the scaling group. During this procedure, the ECS instance is removed from the backend server groups of the associated load balancing instances and from the access whitelists of the associated ApsaraDB RDS instances. Removing:Wait: The ECS instance is waiting to be removed from the scaling group. If a lifecycle hook that applies to scale-down activities is created for the scaling group, the ECS instance is suspended during the removing process and waits for the lifecycle hook timeout to end.	InService
CreationType	string	The method used to create the ECS instance. Valid values: AutoCreated: The ECS instance is created through automatic creation by Auto Scaling based on the instance configuration source. Attached: The ECS instance is not created by Auto Scaling but manually added to the scaling group.	AutoCreated
ZoneId	string	The zone ID of the ECS instance.	cn-hangzhou-g
ScalingConfigurationId	string	The ID of the associated scaling configuration.	asc-bp1i65jd06v04vdh****
Entrusted	boolean	Indicates whether the instance lifecycle is managed by the scaling group when the instance is manually added. Managed instances are released when they are removed from the scaling group (excluding manual removal). Valid values: true: The instance lifecycle is managed by the scaling group. false: The instance lifecycle is not managed by the scaling group.	true
WeightedCapacity	integer	The weight of the instance type, which represents the compute capacity of a single instance of this type in the scaling group. A larger weight means fewer instances of this type are required to meet the expected capacity.	4
CreatedTime	string	The time when the ECS instance was added to the scaling group. The value is accurate to the second.	2020-05-18T03:11:39Z
ScalingActivityId	string	The ID of the scaling activity during which the ECS instance was added to the scaling group.	asa-bp1c9djwrgxjyk31****
ScalingInstanceId	string	The instance identity in the scaling group, which has a one-to-one mapping with the ECS instance identity or ECI instance identity.	asi-j6cj1gcte640ekhb****
PrivateIpAddress	string	The private IP address of the instance in the scaling group.	1*.2.1.2
ReplaceStatus	string	The instance replacement process that the instance is in. Valid values: Normal: The instance is not in any replacement process. ReBalance: The instance is in the scaling group rebalancing replacement process. SpotRemedy: The instance is in the spot compensation replacement process. MaxInstanceLifetimeExpire: The instance is in the maximum instance lifetime expiration replacement process. InstanceRefresh: The instance is in the instance refresh replacement process. SpotReplaceOnDemand: The instance is in the spot-to-pay-as-you-go replacement process.	ReBalance

Examples

Success response

JSON format

{
  "RequestId": "B13527BF-1FBD-4334-A512-20F5E9D3****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalSpotCount": 4,
  "TotalCount": 1,
  "ScalingInstances": [
    {
      "CreationTime": "2020-05-18T03:11Z",
      "LoadBalancerWeight": 50,
      "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
      "InstanceId": "i-bp109k5j3dum1ce6****",
      "SpotStrategy": "SpotWithPriceLimit",
      "LaunchTemplateVersion": "1",
      "HealthStatus": "Healthy",
      "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
      "WarmupState": "NoNeedWarmup",
      "LifecycleState": "InService",
      "CreationType": "AutoCreated",
      "ZoneId": "cn-hangzhou-g",
      "ScalingConfigurationId": "asc-bp1i65jd06v04vdh****",
      "Entrusted": true,
      "WeightedCapacity": 4,
      "CreatedTime": "2020-05-18T03:11:39Z",
      "ScalingActivityId": "asa-bp1c9djwrgxjyk31****",
      "ScalingInstanceId": "asi-j6cj1gcte640ekhb****",
      "PrivateIpAddress": "1**.2*.1**.2**",
      "ReplaceStatus": "ReBalance"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.