Menu
Elastic Load Balancing
API Reference (API Version 2015-12-01)

DescribeLoadBalancers

Describes the specified load balancers or all of your load balancers.

To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

LoadBalancerArns.member.N

The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

Type: Array of strings

Required: No

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Type: String

Required: No

Names.member.N

The names of the load balancers.

Type: Array of strings

Required: No

PageSize

The maximum number of results to return with this call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 400.

Required: No

Response Elements

The following elements are returned by the service.

LoadBalancers.member.N

Information about the load balancers.

Type: Array of LoadBalancer objects

NextMarker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

LoadBalancerNotFound

The specified load balancer does not exist.

HTTP Status Code: 400

Examples

Describe a load balancer

This example describes the specified load balancer.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancers
&LoadBalancerArns.member.1=arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188
&Version=2015-12-01
&AUTHPARAMS

Sample Response

<DescribeLoadBalancersResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/">
  <DescribeLoadBalancersResult>
    <LoadBalancers> 
      <member> 
        <LoadBalancerArn>arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188</LoadBalancerArn> 
        <Scheme>internet-facing</Scheme> 
        <LoadBalancerName>my-load-balancer</LoadBalancerName> 
        <VpcId>vpc-3ac0fb5f</VpcId> 
        <CanonicalHostedZoneId>Z2P70J7EXAMPLE</CanonicalHostedZoneId> 
        <CreatedTime>2016-03-25T21:26:12.920Z</CreatedTime> 
        <AvailabilityZones> 
          <member> 
            <SubnetId>subnet-8360a9e7</SubnetId> 
            <ZoneName>us-west-2a</ZoneName> 
          </member> 
          <member> 
            <SubnetId>subnet-b7d581c0</SubnetId> 
            <ZoneName>us-west-2b</ZoneName> 
          </member> 
        </AvailabilityZones> 
        <SecurityGroups> 
          <member>sg-5943793c</member> 
        </SecurityGroups> 
        <DNSName>my-load-balancer-424835706.us-west-2.elb.amazonaws.com</DNSName> 
        <State> 
          <Code>active</Code> 
        </State> 
        <Type>application</Type> 
      </member> 
    </LoadBalancers> 
  </DescribeLoadBalancersResult> 
  <ResponseMetadata> 
    <RequestId>6581c0ac-f39f-11e5-bb98-57195a6eb84a</RequestId> 
  </ResponseMetadata>
</DescribeLoadBalancersResponse>

Describe all load balancers

This example describes all of your load balancers.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancers
&Version=2015-12-01
&AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: