RegisterInstancesWithLoadBalancer

Amazon Elastic Load Balancing: 2009-05-15

previous page next page

RegisterInstancesWithLoadBalancer

Description

This API adds new instances to the LoadBalancer.

Once the instance is registered, it starts receiving traffic and requests from the LoadBalancer. Any instance that is not in any of the

Availability Zones registered for the LoadBalancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.

You must have been the one who created the LoadBalancer. 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.

[Note]Note
Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.

Request Parameters

Name Description Required

Instances

List of instances IDs that should be registered with the LoadBalancer.

Type: Instances

Default: None

[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

Yes

LoadBalancerName

The mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.

Type: String

Default: None

Constraints: Must only use alphanumeric characters (case sensitive) and dash (-). Dash cannot be first or last character. Maximum length of name is 32 characters (characters are 16-bit Unicode).

Yes

Response Elements

Name Description

Instances

Updated list of instances for the LoadBalancer.

Type: Instances

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

InvalidInstance

This error is returned if any of the specified instances are invalid.

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 /
 ?LoadBalancerName=ReferenceAP1
 &Instances.member.1.InstanceId=i-6055fa09
 &Action=RegisterinstancesWithLoadBalancer
 &Version=2009-05-15
 &AWSAccessKeyId=XXX YOUR ACCESS KEY XXX
 &SignatureVersion=2
 &SignatureMethod=HmacSHA1
 &Timestamp=2009-10-17T05%3A40%3A29.000Z
 &Signature=%XXX YOUR SIGNATURE XXX%3D

Sample Response

Example Query Response 

<RegisterInstancesWithLoadBalancerResult>
	    <Instances>
		      <member>
			        <InstanceId>i-6055fa09</InstanceId>
		      </member>
	    </Instances>
</RegisterInstancesWithLoadBalancerResult>

previous page start next page