Create Load Balancer

Create Load Balancer

Create load balancer

Request
URI
POST
https://{api_host}/iaas/api/load-balancers
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Request Body
LoadBalancerSpecification of type(s) application/json
Optional 
{
    "routes": [
        {
            "protocol": "TCP, UDP",
            "port": "80",
            "memberPort": "80",
            "memberProtocol": "TCP, UDP",
            "healthCheckConfiguration": {
                "protocol": "HTTP, HTTPS",
                "port": "80",
                "timeoutSeconds": 5,
                "unhealthyThreshold": 5,
                "healthyThreshold": 2,
                "urlPath": "/index.html",
                "intervalSeconds": 60
            }
        }
    ],
    "targetLinks": [
        "string"
    ],
    "internetFacing": false,
    "name": "string",
    "nics": [
        {
            "addresses": [
                "string"
            ],
            "securityGroupIds": [
                "string"
            ],
            "name": "string",
            "description": "string",
            "networkId": "dcd9",
            "deviceIndex": 1
        }
    ],
    "description": "string",
    "projectId": "e058",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
array of RouteConfiguration
routes
Required

The load balancer route configuration regarding ports and protocols.

object
customProperties
Optional

Additional custom properties that may be used to extend the load balancer.

array of string
targetLinks
Optional

A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.

boolean
internetFacing
Optional

An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

array of NetworkInterfaceSpecification
nics
Required

A set of network interface specifications for this load balancer.

string
description
Optional

A human-friendly description.

string
projectId
Required

The id of the project the current user belongs to.

array of Tag
tags
Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

Responses
202

successful operation

Returns RequestTracker of type(s) application/json 
{
    "name": "Power-off",
    "progress": 90,
    "resources": [
        "string"
    ],
    "id": "we655aew4e8e",
    "message": "In Progress",
    "status": "FINISHED",
    "selfLink": "/.../request-tracker/we655aew4e8e"
}
string
name
Optional

Name of the operation.

integer As int32 As int32
progress
Required

Progress of the request as percentage.

array of string
resources
Optional

Collection of resources.

string
id
Required

ID of this request.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
string
selfLink
Required

Self link of this request.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

On This Page
Load Balancer Operations
POST
Create Load Balancer
DELETE
Delete Load Balancer
POST
Delete Load Balancer Operation
GET
Get Load Balancer
GET
Get Load Balancers
POST
Scale Load Balancer