Create Load Balancer

Create Load Balancer

Create and save a LoadBalancer

Request
URI
POST
https://{api_host}/iaas-proxy-provider/api/services/{serviceId}/network/load-balancers
COPY
Path Parameters
string
serviceId
Required

The ID of the IaaS service as registered in the Component Registry service.


Request Body

The Load Balancer to be created and saved.

loadBalancer of type(s) application/json
Required
This request body class requires all of the following: networkObject , InlineloadBalancer1
{
    "name": "string",
    "description": "string",
    "externalId": "string",
    "id": "string",
    "extensionData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "loadBalancerTypeId": "string",
    "virtualIps": [
        {
            "address": "string",
            "poolId": "string",
            "name": "string",
            "description": "string",
            "externalId": "string",
            "id": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "vipNetwork": "string",
    "pools": [
        {
            "persistenceExpiration": 0,
            "description": "string",
            "healthCheckProtocol": "string",
            "transparent": false,
            "persistenceCookieMode": "string",
            "acceleration": false,
            "protocol": "string",
            "memberMaxConnections": 0,
            "members": [
                {
                    "address": "string",
                    "port": 0,
                    "id": "string",
                    "extensionData": {
                        "entries": [
                            {
                                "key": "string"
                            }
                        ]
                    }
                }
            ],
            "algorithmParameter": "string",
            "memberMinConnections": 0,
            "monitorIds": [
                "string"
            ],
            "id": "string",
            "monitorPort": 0,
            "algorithm": "string",
            "uniqueMonitorId": "string",
            "servicePortId": "string",
            "persistenceCookieName": "string",
            "externalId": "string",
            "connectionRate": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            },
            "connectionLimit": 0,
            "port": 0,
            "memberPort": 0,
            "persistenceMethod": "string",
            "name": "string"
        }
    ],
    "vipNicIndex": 0,
    "tierNetwork": "string",
    "tierNicIndex": 0,
    "loggingLevel": "string",
    "monitors": [
        {
            "receive": "string",
            "maxRetries": 0,
            "method": "string",
            "newEntity": false,
            "interval": 0,
            "monitorPath": "string",
            "id": "string",
            "send": "string",
            "timeout": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ]
}
Responses
200

successful operation

Returns loadBalancer of type(s) */*
This response body class contains all of the following: networkObject , InlineloadBalancer1
{
    "name": "string",
    "description": "string",
    "externalId": "string",
    "id": "string",
    "extensionData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "loadBalancerTypeId": "string",
    "virtualIps": [
        {
            "address": "string",
            "poolId": "string",
            "name": "string",
            "description": "string",
            "externalId": "string",
            "id": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "vipNetwork": "string",
    "pools": [
        {
            "persistenceExpiration": 0,
            "description": "string",
            "healthCheckProtocol": "string",
            "transparent": false,
            "persistenceCookieMode": "string",
            "acceleration": false,
            "protocol": "string",
            "memberMaxConnections": 0,
            "members": [
                {
                    "address": "string",
                    "port": 0,
                    "id": "string",
                    "extensionData": {
                        "entries": [
                            {
                                "key": "string"
                            }
                        ]
                    }
                }
            ],
            "algorithmParameter": "string",
            "memberMinConnections": 0,
            "monitorIds": [
                "string"
            ],
            "id": "string",
            "monitorPort": 0,
            "algorithm": "string",
            "uniqueMonitorId": "string",
            "servicePortId": "string",
            "persistenceCookieName": "string",
            "externalId": "string",
            "connectionRate": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            },
            "connectionLimit": 0,
            "port": 0,
            "memberPort": 0,
            "persistenceMethod": "string",
            "name": "string"
        }
    ],
    "vipNicIndex": 0,
    "tierNetwork": "string",
    "tierNicIndex": 0,
    "loggingLevel": "string",
    "monitors": [
        {
            "receive": "string",
            "maxRetries": 0,
            "method": "string",
            "newEntity": false,
            "interval": 0,
            "monitorPath": "string",
            "id": "string",
            "send": "string",
            "timeout": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ]
}

201

The load balancer is created.

Returns loadBalancer of type(s) */*
This response body class contains all of the following: networkObject , InlineloadBalancer1
{
    "name": "string",
    "description": "string",
    "externalId": "string",
    "id": "string",
    "extensionData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "loadBalancerTypeId": "string",
    "virtualIps": [
        {
            "address": "string",
            "poolId": "string",
            "name": "string",
            "description": "string",
            "externalId": "string",
            "id": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "vipNetwork": "string",
    "pools": [
        {
            "persistenceExpiration": 0,
            "description": "string",
            "healthCheckProtocol": "string",
            "transparent": false,
            "persistenceCookieMode": "string",
            "acceleration": false,
            "protocol": "string",
            "memberMaxConnections": 0,
            "members": [
                {
                    "address": "string",
                    "port": 0,
                    "id": "string",
                    "extensionData": {
                        "entries": [
                            {
                                "key": "string"
                            }
                        ]
                    }
                }
            ],
            "algorithmParameter": "string",
            "memberMinConnections": 0,
            "monitorIds": [
                "string"
            ],
            "id": "string",
            "monitorPort": 0,
            "algorithm": "string",
            "uniqueMonitorId": "string",
            "servicePortId": "string",
            "persistenceCookieName": "string",
            "externalId": "string",
            "connectionRate": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            },
            "connectionLimit": 0,
            "port": 0,
            "memberPort": 0,
            "persistenceMethod": "string",
            "name": "string"
        }
    ],
    "vipNicIndex": 0,
    "tierNetwork": "string",
    "tierNicIndex": 0,
    "loggingLevel": "string",
    "monitors": [
        {
            "receive": "string",
            "maxRetries": 0,
            "method": "string",
            "newEntity": false,
            "interval": 0,
            "monitorPath": "string",
            "id": "string",
            "send": "string",
            "timeout": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ]
}