DescribeLoadBalancers
Note
This API operation is superseded by DescribeTrafficSources,
which can describe multiple traffic sources types. We recommend using
DescribeTrafficSources to simplify how you manage traffic sources.
However, we continue to support DescribeLoadBalancers. You can use both
the original DescribeLoadBalancers API operation and
DescribeTrafficSources on the same Auto Scaling group.
Gets information about the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
To determine the attachment status of the load balancer, use the State
element in the response. When you attach a load balancer to an Auto Scaling group, the initial
State value is Adding. The state transitions to
Added after all Auto Scaling instances are registered with the load balancer.
If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to
InService after at least one Auto Scaling instance passes the health check.
When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate
and replace any instances that are reported as unhealthy. If no registered instances
pass the health checks, the load balancer doesn't enter the InService
state.
Load balancers also have an InService state if you attach them in the
CreateAutoScalingGroup API call. If your load balancer state is
InService, but it is not working properly, check the scaling activities
by calling DescribeScalingActivities and take any corrective actions
necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- MaxRecords
-
The maximum number of items to return with this call. The default value is
100and the maximum value is100.Type: Integer
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
Response Elements
The following elements are returned by the service.
- LoadBalancers.member.N
-
The load balancers.
Type: Array of LoadBalancerState objects
- NextToken
-
A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextTokenvalue when requesting the next set of items. This value is null when there are no more items to return.Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextToken
-
The
NextTokenvalue is not valid.HTTP Status Code: 400
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribeLoadBalancers.
Sample Request
https://autoscaling.amazonaws.com/?Action=DescribeLoadBalancers
&AutoScalingGroupName=my-asg
&Version=2011-01-01
&AUTHPARAMS Sample Response
<DescribeLoadBalancersResponse xmlns="https://autoscaling.amazonaws.com/doc/2011-01-01/">
<DescribeLoadBalancersResult>
<LoadBalancers>
<member>
<LoadBalancerName>my-loadbalancer</LoadBalancerName>
<State>Added</State>
</member>
</LoadBalancers>
</DescribeLoadBalancersResult>
<ResponseMetadata>
<RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>
</ResponseMetadata>
</DescribeLoadBalancersResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
