DescribeLoadBalancers

Amazon Elastic Load Balancing: 2009-05-15

previous page next page

DescribeLoadBalancers

Description

This API returns detailed configuration information for the specified LoadBalancers, or if no LoadBalancers are specified, then the API returns configuration information for all LoadBalancers created by the caller. For more information, please see

LoadBalancer.

You must have created the specified input LoadBalancers in order to retrieve this information. In other words, in order to successfully call this API, you must provide the same account credentials as those that were used to create the LoadBalancer.

Request Parameters

Name Description Required

LoadBalancerNames

A list of LoadBalancerNames, the mnemonic name that was associated with the LoadBalancer at creation time.

Type: LoadBalancerNames

Default: If the list is empty, the call will return descriptions for all the LoadBalancers active.

[Note]Note

Some API operations take lists of parameters. These lists are specified using the following notation: param.member.n. Values of n are integers starting from 1. All lists of parameters must follow this notation, including lists that only contain one parameter. For example, a Query parameter list looks like this:

&attribute.member.1=this
&attribute.member.2=that

No

Response Elements

Name Description

LoadBalancerDescriptions

List of LoadBalancer description structures.

Type: LoadBalancerDescription

Special Errors

Common errors for all calls are listed and described in a separate section, please see API Error Codes.

Error Description HTTP Status Code SOAP Prefix

LoadBalancerNotFound

LoadBalancer name does not exist for the account in this region. (For more information, please see LoadBalancer.)

400 Bad Request Client

ValidationError

One or more input parameters are invalid.

400 Bad Request Client

Examples

Sample Request

Example Request (Query) 

https://elasticloadbalancing.amazonaws.com /
 ?Action=DescribeLoadBalancers
 &Version=2009-05-15
 &AWSAccessKeyId=XXX YOUR ACCESS KEY XXX
 &SignatureVersion=2
 &SignatureMethod=HmacSHA1
 &Timestamp=2009-10-17T05%3A14%3A21.000Z
 &Signature=%XXX YOUR SIGNATURE XXX%3D

Sample Response

Example Query Response 

<DescribeLoadBalancersResult>
	  <LoadBalancersDescriptions>
	  <member>
		    <Listeners>		      
		     <member>
		      	<Protocol>HTTP</Protocol>
		      	<LoadBalancerPort>80</LoadBalancerPort>
		      	<InstancePort>80</InstancePort>
		      </member>
		     </Listeners>
		     </LoadBalancerName>TestLoadBalancer</LoadBalancerName>
			 </Instances/>
			 </CreatedTime>2009-04-03T18:22:30Z</CreatedTime>
			 <HealthCheck>
				<Interval>30</Interval>
				<Target>TCP:80</Target>
				<HealthyThreshold>10</HealthyThreshold>
				<Timeout>5</Timeout>
				<UnhealthyThreshold>2</UnhealthyThreshold>
			 </HealthCheck>
			 <DNSName>TestLoadBalancer-400948911.us-east-1.elb.amazonaws.com</DNSName>      
			 <AvailabilityZones>
			  <member>us-east-1b</member>
			 </AvailabilityZones>
      </member>
	   </LoadBalancersDescriptions>
</DescribeLoadBalancersResult>

The following operations also return information on the LoadBalancer and/or its instances.

previous page start next page