RegisterInstancesWithLoadBalancer

Description

Adds the specified instances as distribution destinations to the specified load balancer.

After the instance is registered, the load will be distributed among it and the other existing instances.

Even if an IP address of a distribution destination instance registered to the load balancer is changed, the load will not be distributed to the new IP address.

When operations that involve the changing of IP addresses, such as the restarting of distribution destination instances when DHCP is enabled, or users manually changing the IP addresses of distribution destination instances when DHCP is disabled, it is necessary to delete the load balancer from the target distribution destination instances and reregister it.

Distribution destination instances must be started before being registered to a load balancer.

Refer to "DeregisterInstancesFromLoadBalancer" for details on how to delete registered distribution destination instances from a load balancer.

This API can be used only by users with account privileges belonging to the same project as the account used when creating the load balancer.

Refer to "DescribeLoadBalancers" for details on how to check the status of registered distribution destination instances.

Request Parameters

Refer to "Common Parameters" for details on standard parameter information used by all actions.

• Instances.member.N

  List of instance IDs to register to the load balancer.

  • Type: Instance list
  • Required: Yes
• LoadBalancerName

  Name of the load balancer to register the instances to.

  The name must be unique among the load balancers in the projects to which the account belongs.

  • Type: String
  • Required: Yes

Response

The following status code is returned.

• Normal response code

  This operation was accepted normally.

  • HTTP Status Code: 200

Response Elements

The following element is returned in a structure called the RegisterInstancesWithLoadBalancerResult.

• Instances

  List of updated distribution destination instances of the load balancer.

  • Type: InstanceDescription list

Errors

Refer to "Common Errors" for details on error information common to all operations.

• AccessPointNotFound

  The specified load balancer was not found.

  • HTTP Status Code: 400
• InvalidEndPoint

  The specified endpoint is invalid.

  • HTTP Status Code: 400
• InvalidConfigurationRequest

  The requested configuration change is invalid.

  • HTTP Status Code: 409

Examples

Sample Request

The example below registers the distribution destination instance with the ID i-315b7e51 to the load balancer named MyLB01.

https://loadbalancing.(regionName).cloud.global.fujitsu.com/?Instances.member.1.InstanceId=i-315b7e51
&LoadBalancerName=MyLB01
&Version=2014-11-01
&Action=RegisterInstancesWithLoadBalancer   
     

The example below registers the distribution destination instance with the ID i-315b7e51 and port ID p-315b7e51 to the load balancer named MyLB01.

https://loadbalancing.(regionName).cloud.global.fujitsu.com/?Instances.member.1.InstanceId=i-315b7e51
&Instances.member.1.PortId=p-315b7e51
&LoadBalancerName=MyLB01
&Version=2014-11-01
&Action=RegisterInstancesWithLoadBalancer       
     

Sample Response (XML)

<RegisterInstancesWithLoadBalancerResponse xmlns=" http://docs.cloudcommunity.global.fujitsu.com/loadbalancing/api/v1.0">
  <RegisterInstancesWithLoadBalancerResult>
    <Instances>
      <member>
        <InstanceId>i-712cde1e</InstanceId>
      </member>
      <member>
        <InstanceId>i-315b7e51</InstanceId>
        <PortId>p-315b7e51</PortId>
      </member>
    </Instances>
  </RegisterInstancesWithLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>
  </ResponseMetadata>
</RegisterInstancesWithLoadBalancerResponse>     
     

Sample Response (JSON)

{
  "RegisterInstancesWithLoadBalancerResponse": {
    "RegisterInstancesWithLoadBalancerResult": {
      "Instances": {
        "member": [
          {
           "InstanceId": "i-712cde1e"
          },
          {
           "InstanceId": "i-315b7e51"
           "PortId": "p-315b7e51"
          }
        ]
      }
    },
    "ResponseMetadata": {
      "RequestId": "83c88b9d-12b7-11e3-8b82-87b12EXAMPLE"
    }
  }
}