DeregisterInstancesFromLoadBalancer

Description

Deregisters the specified distribution destination instances from the specified load balancer.

After a distribution destination instance is deregistered, it no longer receives traffic from the 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" to check if the distribution destination instances have been deregistered from the load balancer.

Request parameters

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

• Instances.member.N

  List of distribution destination instance IDs to deregister.

  • Type: Instance list
  • Required: Yes
• LoadBalancerName

  Name of the load balancer.

  • 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 DeregisterInstancesFromLoadBalancerResult.

• Instances

  List of remaining distribution destination instances registered with the updated load balancer.

  • Type: [InstanceDescription] list

Errors

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

• AccessPointNotFound

  The specified load balancer could not be found.

  • HTTP Status Code: 400
• InvalidEndPoint

  The specified EndPoint is not valid.

  • HTTP Status Code: 400

Examples

Sample Request

The example below deregisters the distribution destination instance with the ID i-e3677ad7 from the load balancer named MyLB01.

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

Sample Response (XML)

<DeregisterInstancesFromLoadBalancerResponse xmlns=" http://docs.cloudcommunity.global.fujitsu.com/loadbalancing/api/v1.0">
  <DeregisterInstancesFromLoadBalancerResult>
    <Instances>
      <member>
        <InstanceId>i-6ec63d59</InstanceId>
        <PortId>p-6ec63d59</PortId>
      </member>
      <member>
        <InstanceId>i-34cde612</InstanceId>
      </member>
    </Instances>
  </DeregisterInstancesFromLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>
  </ResponseMetadata>
</DeregisterInstancesFromLoadBalancerResponse>      
     

Sample Response (JSON)

{
  "DeregisterInstancesFromLoadBalancerResponse": {
    "DeregisterInstancesFromLoadBalancerResult": {
      "Instances": {
        "member": [
          {
           "InstanceId": "i-6ec63d59"
           "PortId": "p-6ec63d59"
          },
          {
           "InstanceId": "i-34cde612"
          }
        ] 
      }
    },
    "ResponseMetadata": {
      "RequestId": "83c88b9d-12b7-11e3-8b82-87b12EXAMPLE"
    }
  }
}