• No results found

Description of a specified load balancer

Sample Request

<LoadBalancerDescriptions>

<member>

<SecurityGroups/>

<LoadBalancerName>MyLoadBalancer</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>

Elastic Load Balancing API Reference Examples

<member>us-east-1a</member>

</AvailabilityZones>

<CanonicalHostedZoneNameID>ZZZZZZZZZZZ123X</CanonicalHostedZoneNameID>

<CanonicalHostedZoneName>MyLoadBalancer-123456789.us-east-1.elb.amazonaws.com</CanonicalHostedZoneName>

<Scheme>internet-facing</Scheme>

<SourceSecurityGroup>

<OwnerAlias>amazon-elb</OwnerAlias>

<GroupName>amazon-elb-sg</GroupName>

</SourceSecurityGroup>

<DNSName>MyLoadBalancer-123456789.us-east-1.elb.amazonaws.com</DNSName>

<BackendServerDescriptions/>

<Subnets/>

</member>

</LoadBalancerDescriptions>

</DescribeLoadBalancersResult>

<ResponseMetadata>

<RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>

</ResponseMetadata>

</ DescribeLoadBalancerPolicyTypesResponse >

DescribeTags

Description

Describes the tags associated with one or more load balancers.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters (p. 93).

LoadBalancerNames.member.N The names of the load balancers.

Type: String list

Length constraints: Minimum of 1 item(s) in the list. Maximum of 20 item(s) in the list.

Required: Yes

Response Elements

The following element is returned in a structure named DescribeTagsResult.

TagDescriptions

A list of tag description structures.

Type:TagDescription (p. 91) list

Errors

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

AccessPointNotFound

The specified load balancer could not be found.

HTTP Status Code: 400

Examples

Sample Request

https://elasticloadbalancing.amazonaws.com//?Action=DescribeTags

&LoadBalancerNames.member.1=my-test-loadbalancer

&Version=2012-06-01

&AUTHPARAMS

Elastic Load Balancing API Reference DescribeTags

Sample Response

<DescribeTagsResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/">

<DescribeTagsResult>

<TagDescriptions>

<member>

<Tags>

<Value>lima</Value>

<Key>project</Key>

</member>

<member>

<Value>digital-media</Value>

<Key>department</Key>

</member>

</Tags>

<LoadBalancerName>my-test-loadbalancer</LoadBalancerName>

</member>

</TagDescriptions>

<ResponseMetadata>

<RequestId>07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE</RequestId>

</ResponseMetadata>

</DescribeTagsResponse>

DetachLoadBalancerFromSubnets

Description

Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.

After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters (p. 93).

LoadBalancerName

The name associated with the load balancer to be detached.

Type: String Required: Yes Subnets.member.N

A list of subnet IDs to remove from the set of configured subnets for the load balancer.

Type: String list Required: Yes

Response Elements

The following element is returned in a structure named DetachLoadBalancerFromSubnetsResult.

Subnets

A list of subnet IDs the load balancer is now attached to.

Type: String list

Errors

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

AccessPointNotFound

The specified load balancer could not be found.

HTTP Status Code: 400 InvalidConfigurationRequest

Requested configuration change is invalid.

HTTP Status Code: 409

Elastic Load Balancing API Reference DetachLoadBalancerFromSubnets

Examples

Sample Request

https://elasticloadbalancing.amazonaws.com/?Subnets.member.1=subnet-119f0078

&LoadBalancerName=my-test-vpc-loadbalancer

&Version=2012-06-01

&Action=DetachLoadBalancerFromSubnets

&AUTHPARAMS

Sample Response

<DetachLoadBalancerFromSubnetsResponse xmlns="http://elasticloadbalancing.amazon aws.com/doc/2012-06-01/">

<DetachLoadBalancerFromSubnetsResult>

<Subnets>

<member>subnet-159f007c</member>

<member>subnet-3561b05e</member>

</Subnets>

</DetachLoadBalancerFromSubnetsResult>

<ResponseMetadata>

<RequestId>07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE</RequestId>

</ResponseMetadata>

</DetachLoadBalancerFromSubnetsResponse>

DisableAvailabilityZonesForLoadBalancer

Description

Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.

There must be at least one Availability Zone registered with a load balancer at all times. Once an Avail-ability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availab-ility Zone that was not associated with the load balancer does nothing.

For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters (p. 93).

AvailabilityZones.member.N

A list of Availability Zones to be removed from the load balancer.

Note

There must be at least one Availability Zone registered with a load balancer at all times.

Specified Availability Zones must be in the same region.

Type: String list Required: Yes LoadBalancerName

The name associated with the load balancer.

Type: String Required: Yes

Response Elements

The following element is returned in a structure named DisableAvailabilityZonesForLoadBalan-cerResult.

AvailabilityZones

A list of updated Availability Zones for the load balancer.

Type: String list

Errors

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

AccessPointNotFound

The specified load balancer could not be found.

Elastic Load Balancing API Reference DisableAvailabilityZonesForLoadBalancer

HTTP Status Code: 400 InvalidConfigurationRequest

Requested configuration change is invalid.

HTTP Status Code: 409

Examples

Sample Request

https://elasticloadbalancing.amazonaws.com/?AvailabilityZones.member.1=us-east-1a

&LoadBalancerName=MyHTTPSLoadBalancer

&Version=2012-06-01

&Action=DisableAvailabilityZonesForLoadBalancer

&AUTHPARAMS

Sample Response

<DisableAvailabilityZonesForLoadBalancerResponse xmlns="http://elasticloadbal ancing.amazonaws.com/doc/2012-06-01/">

<DisableAvailabilityZonesForLoadBalancerResult>

<AvailabilityZones>

<member>us-east-1b</member>

</AvailabilityZones>

</DisableAvailabilityZonesForLoadBalancerResult>

<ResponseMetadata>

<RequestId>ba6267d5-2566-11e3-9c6d-eb728EXAMPLE</RequestId>

</ResponseMetadata>

</DisableAvailabilityZonesForLoadBalancerResponse>

EnableAvailabilityZonesForLoadBalancer

Description

Adds one or more EC2 Availability Zones to the load balancer.

The load balancer evenly distributes requests across all its registered Availability Zones that contain in-stances.

Note

The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created.

For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters (p. 93).

AvailabilityZones.member.N

A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer.

Type: String list Required: Yes LoadBalancerName

The name associated with the load balancer.

Type: String Required: Yes

Response Elements

The following element is returned in a structure named EnableAvailabilityZonesForLoadBalan-cerResult.

AvailabilityZones

An updated list of Availability Zones for the load balancer.

Type: String list

Errors

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

AccessPointNotFound

The specified load balancer could not be found.

HTTP Status Code: 400

Elastic Load Balancing API Reference EnableAvailabilityZonesForLoadBalancer

Examples

Related documents