docs.aws.amazon.com Open in urlscan Pro
99.84.133.24  Public Scan

Submitted URL: http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DescribeLoadBalancers.html
Effective URL: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html
Submission: On November 15 via api from JP — Scanned from JP

Form analysis 0 forms found in the DOM

Text Content

SELECT YOUR COOKIE PREFERENCES

We use essential cookies and similar tools that are necessary to provide our
site and services. We use performance cookies to collect anonymous statistics so
we can understand how customers use our site and make improvements. Essential
cookies cannot be deactivated, but you can click “Customize cookies” to decline
performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide
useful site features, remember your preferences, and display relevant content,
including relevant advertising. To continue without accepting these cookies,
click “Continue without accepting.” To make more detailed choices or learn more,
click “Customize cookies.”

Accept all cookiesContinue without acceptingCustomize cookies


CUSTOMIZE COOKIE PREFERENCES

We use cookies and similar tools (collectively, "cookies") for the following
purposes.


ESSENTIAL

Essential cookies are necessary to provide our site and services and cannot be
deactivated. They are usually set in response to your actions on the site, such
as setting your privacy preferences, signing in, or filling in forms.




PERFORMANCE

Performance cookies provide anonymous statistics about how customers navigate
our site so we can improve site experience and performance. Approved third
parties may perform analytics on our behalf, but they cannot use the data for
their own purposes.

Allow performance category
Allowed


FUNCTIONAL

Functional cookies help us provide useful site features, remember your
preferences, and display relevant content. Approved third parties may set these
cookies to provide certain site features. If you do not allow these cookies,
then some or all of these services may not function properly.

Allow functional category
Allowed


ADVERTISING

Advertising cookies may be set through our site by us or our advertising
partners and help us deliver relevant marketing content. If you do not allow
these cookies, you will experience less relevant advertising.

Allow advertising category
Allowed

Blocking some types of cookies may impact your experience of our sites. You may
review and change your choices at any time by clicking Cookie preferences in the
footer of this site. We and selected third-parties use cookies or similar
technologies as specified in the AWS Cookie Notice.

CancelSave preferences




UNABLE TO SAVE COOKIE PREFERENCES

We will only store essential cookies at this time, because we were unable to
save your cookie preferences.

If you want to change your cookie preferences, try again later using the link in
the AWS console footer, or contact support if the problem persists.

Dismiss


Contact Us
English



Create an AWS Account
 1. AWS
 2. ...
    
    
 3. Documentation
 4. Elastic Load Balancing
 5. API Reference

Feedback
Preferences


ELASTIC LOAD BALANCING


API REFERENCE

 * Welcome
 * Actions
    * AddTags
    * ApplySecurityGroupsToLoadBalancer
    * AttachLoadBalancerToSubnets
    * ConfigureHealthCheck
    * CreateAppCookieStickinessPolicy
    * CreateLBCookieStickinessPolicy
    * CreateLoadBalancer
    * CreateLoadBalancerListeners
    * CreateLoadBalancerPolicy
    * DeleteLoadBalancer
    * DeleteLoadBalancerListeners
    * DeleteLoadBalancerPolicy
    * DeregisterInstancesFromLoadBalancer
    * DescribeAccountLimits
    * DescribeInstanceHealth
    * DescribeLoadBalancerAttributes
    * DescribeLoadBalancerPolicies
    * DescribeLoadBalancerPolicyTypes
    * DescribeLoadBalancers
    * DescribeTags
    * DetachLoadBalancerFromSubnets
    * DisableAvailabilityZonesForLoadBalancer
    * EnableAvailabilityZonesForLoadBalancer
    * ModifyLoadBalancerAttributes
    * RegisterInstancesWithLoadBalancer
    * RemoveTags
    * SetLoadBalancerListenerSSLCertificate
    * SetLoadBalancerPoliciesForBackendServer
    * SetLoadBalancerPoliciesOfListener

 * Data Types
    * AccessLog
    * AdditionalAttribute
    * AppCookieStickinessPolicy
    * BackendServerDescription
    * ConnectionDraining
    * ConnectionSettings
    * CrossZoneLoadBalancing
    * HealthCheck
    * Instance
    * InstanceState
    * LBCookieStickinessPolicy
    * Limit
    * Listener
    * ListenerDescription
    * LoadBalancerAttributes
    * LoadBalancerDescription
    * Policies
    * PolicyAttribute
    * PolicyAttributeDescription
    * PolicyAttributeTypeDescription
    * PolicyDescription
    * PolicyTypeDescription
    * SourceSecurityGroup
    * Tag
    * TagDescription
    * TagKeyOnly

 * Common Errors
 * Common Parameters
 * Query Requests
 * SOAP API

DescribeLoadBalancers - Elastic Load Balancing
AWSDocumentationElastic Load BalancingAPI Reference
Request ParametersResponse ElementsErrorsExamplesSee Also


DESCRIBELOADBALANCERS


PDF

Describes the specified load balancers. If no load balancers are specified, the
call describes all of your load balancers.


REQUEST PARAMETERS


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

LoadBalancerNames.member.N

The names of the load balancers.

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

PageSize

The maximum number of results to return with this call (a number from 1 to 400).
The default is 400.

Type: Integer

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

Required: No


RESPONSE ELEMENTS


The following elements are returned by the service.

LoadBalancerDescriptions.member.N

Information about the load balancers.

Type: Array of LoadBalancerDescription 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.

DependencyThrottle

A request made by Elastic Load Balancing to another service exceeds the maximum
request rate permitted for your account.

HTTP Status Code: 400

LoadBalancerNotFound

The specified load balancer does not exist.

HTTP Status Code: 400


EXAMPLES



DESCRIBE A CLASSIC LOAD BALANCER

This example describes the specified load balancer.

SAMPLE REQUEST

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancers
&LoadBalancerNames.member.1=my-loadbalancer
&Version=2012-06-01
&AUTHPARAMS 

SAMPLE RESPONSE

<DescribeLoadBalancersResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/">
  <DescribeLoadBalancersResult>
    <LoadBalancerDescriptions>
      <member>
        <SecurityGroups/>
        <LoadBalancerName>my-loadbalancer</LoadBalancerName>
        <CreatedTime>2013-05-24T21:15:31.280Z</CreatedTime>
        <HealthCheck>
          <Interval>90</Interval>
          <Target>HTTP:80/</Target>
          <HealthyThreshold>2</HealthyThreshold>
          <Timeout>60</Timeout>
          <UnhealthyThreshold>10</UnhealthyThreshold>
        </HealthCheck>
        <ListenerDescriptions>
          <member>
            <PolicyNames/>
            <Listener>
              <Protocol>HTTP</Protocol>
              <LoadBalancerPort>80</LoadBalancerPort>
              <InstanceProtocol>HTTP</InstanceProtocol>
              <InstancePort>80</InstancePort>
            </Listener>
          </member>
        </ListenerDescriptions>
        <Instances>
          <member>
            <InstanceId>i-e4cbe38d</InstanceId>
          </member>
        </Instances>
        <Policies>
          <AppCookieStickinessPolicies/>
          <OtherPolicies/>
          <LBCookieStickinessPolicies/>
        </Policies>
        <AvailabilityZones>
          <member>us-east-1a</member>
        </AvailabilityZones>
        <CanonicalHostedZoneNameID>ZZZZZZZZZZZ123X</CanonicalHostedZoneNameID>
        <CanonicalHostedZoneName>my-loadbalancer-123456789.us-east-1.elb.amazonaws.com</CanonicalHostedZoneName>
        <Scheme>internet-facing</Scheme>
        <SourceSecurityGroup>
          <OwnerAlias>amazon-elb</OwnerAlias>
          <GroupName>amazon-elb-sg</GroupName>
        </SourceSecurityGroup>
        <DNSName>my-loadbalancer-123456789.us-east-1.elb.amazonaws.com</DNSName>
        <BackendServerDescriptions/>
        <Subnets/>
      </member>
    </LoadBalancerDescriptions>
  </DescribeLoadBalancersResult>
  <ResponseMetadata>
    <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>
  </ResponseMetadata>
</DescribeLoadBalancersResponse> 


SEE ALSO


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

 * AWS Command Line Interface

 * AWS SDK for .NET

 * AWS SDK for C++

 * AWS SDK for Go v2

 * AWS SDK for Java V2

 * AWS SDK for JavaScript V3

 * AWS SDK for PHP V3

 * AWS SDK for Python

 * AWS SDK for Ruby V3

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please
refer to your browser's Help pages for instructions.

Document Conventions
DescribeLoadBalancerPolicyTypes
DescribeTags
Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of
it.



Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.





DID THIS PAGE HELP YOU?

Yes
No
Provide feedback

NEXT TOPIC:

DescribeTags

PREVIOUS TOPIC:

DescribeLoadBalancerPolicyTypes

NEED HELP?

 * Try AWS re:Post 
 * Connect with an AWS IQ expert 

PrivacySite termsCookie preferences
© 2024, Amazon Web Services, Inc. or its affiliates. All rights reserved.


ON THIS PAGE

 * Request Parameters
 * Response Elements
 * Errors
 * Examples
 * See Also