CreateLoadBalancer

Description

Creates a load balancer.

If load balancer creation completes successfully, notification of a unique DNS name is sent.

Up to 20 load balancers can be created for projects to which the account belongs.

When creating a load balancer, SSLNegotiationPolicy is set as default.

Request parameters

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

  • Listeners.member.N

    List of listeners, including LoadBalancerPort, InstancePort, and Protocol.

  • LoadBalancerName

    Name of the load balancer.

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

    Specify the value using up to 30 characters.

    You can specify alphanumeric characters and hyphens (-).

    • Type: String
    • Required: Yes
  • Scheme

    Type of the load balancer.

    Specify public to create a load balancer over the Internet.

    Specify internal to create a load balancer from a private network.

    • Type: String
    • Default: public
    • Valid values: public | internal
    • Required: No
  • SecurityGroups.member.N

    List of security group IDs.

    If omitted, the default security group of the user's project will be used.

    • Type: String list
    • Required: No
  • Subnets.member.N

    List of subnet IDs.

    Specify the same subnet as the distribution destination instance that is to be registered in the following cases.

    • When using the health check function for VM instance using autoscaling (AutoScaling)
    • When monitoring load balancer monitoring items using the monitoring service

    • Type: String list
    • Required: Yes
  • Grade

    Grade of the load balancer (performance type).

    Select from a standard grade load balancer (Standard), medium performance grade load balancer (Middle), or high performance grade load balancer (High).

    • Type: String
    • Default: Standard
    • Valid values: Standard | Middle | High
    • Required: No

Response

The following status code is returned.

  • Normal response code

    This operation was accepted normally.

    • HTTP Status Code: 200

Response Elements

The following is returned in a structure called the CreateLoadBalancerResult.

  • DNSName

    DNS name of load balancer.

    • Type: String

Errors

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

  • CertificateNotFound

    The specified SSL ID does not refer to a valid SSL certificate in the Key Management Service.

    • HTTP Status Code: 400
  • DuplicateAccessPointName

    Load balancer name already exists for this account. Please choose another name.

    • HTTP Status Code: 400
  • InvalidConfigurationRequest

    Requested configuration change is invalid.

    • HTTP Status Code: 409
  • InvalidScheme

    Invalid value for scheme. Scheme can only be specified for load balancers in the Virtual system.

    • HTTP Status Code: 400
  • InvalidSecurityGroup

    One or more of the specified security groups do not exist.

    • HTTP Status Code: 400
  • InvalidSubnet

    The Virtual system has no Internet gateway.

    • HTTP Status Code: 400
  • SubnetNotFound

    One or more subnets were not found.

    • HTTP Status Code: 400
  • TooManyAccessPoints

    The quota for the number of load balancers has already been reached.

    • HTTP Status Code: 400

Examples

Sample Request

The example below creates a load balancer named MyLB01 and a listener for the 80/http port/protocol for front-end and back-end connections.


       https://loadbalancing.(regionName).cloud.global.fujitsu.com/?LoadBalancerName=MyLB01
       &Listeners.member.1.LoadBalancerPort=80
       &Listeners.member.1.InstancePort=80
       &Listeners.member.1.Protocol=http
       &Listeners.member.1.InstanceProtocol=http
       &Scheme=internal
       &Subnets.member.1=subnet-3561b05d
       &Version=2014-11-01
       &Action=CreateLoadBalancer
       

Sample response (XML)


       <CreateLoadBalancerResponse xmlns=" http://docs.cloudcommunity.global.fujitsu.com/loadbalancing/api/v1.0">
  <CreateLoadBalancerResult>
    <DNSName>MyLB01-1234567890.aa.bbbb.cccc.dddd</DNSName>
  </CreateLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>
  </ResponseMetadata>
</CreateLoadBalancerResponse>
       

Sample Response (JSON)


       {
  "CreateLoadBalancerResponse": {
    "CreateLoadBalancerResult": {
      "DNSName": "MyLB01-1234567890.aa.bbbb.cccc.dddd"
    },
    "ResponseMetadata": {
      "RequestId": "1549581b-12b7-11e3-895e-1334aEXAMPLE"
    }
  }
}