Get Load Balancer

Get Load Balancer

Retrieve a load balancer by ID

Request
URI
GET
https://{api_host}/network-service//api/load-balancers/{id}
COPY
Path Parameters
string
id
Required

Load balancer ID

Responses
200

Successfully returned Load balancer

Returns LoadBalancer of type(s) */* 
{
    "loadBalancerTypeId": "string",
    "description": "string",
    "externalId": "string",
    "pools": [
        {
            "persistenceExpiration": 0,
            "description": "string",
            "healthCheckProtocol": "string",
            "sslClientProfileName": "string",
            "transparent": false,
            "persistenceCookieMode": "string",
            "acceleration": false,
            "protocol": "string",
            "memberMaxConnections": 0,
            "members": [
                {
                    "address": "string",
                    "port": 0,
                    "externalId": "string",
                    "id": "string",
                    "extensionData": {
                        "entries": [
                            {
                                "key": "string"
                            }
                        ]
                    }
                }
            ],
            "algorithmParameter": "string",
            "memberMinConnections": 0,
            "monitorIds": [
                "string"
            ],
            "id": "string",
            "monitorPort": 0,
            "algorithm": "string",
            "uniqueMonitorId": "string",
            "sslDefaultCertificateName": "string",
            "servicePortId": "string",
            "persistenceCookieName": "string",
            "externalId": "string",
            "connectionRate": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            },
            "connectionLimit": 0,
            "port": 0,
            "memberPort": 0,
            "persistenceMethod": "string",
            "name": "string",
            "tenantId": "string",
            "memberProtocol": "string"
        }
    ],
    "vipNicIndex": 0,
    "tierNetwork": "string",
    "extensionData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "virtualIps": [
        {
            "address": "string",
            "name": "string",
            "tenantId": "string",
            "poolId": "string",
            "description": "string",
            "externalId": "string",
            "id": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "name": "string",
    "tenantId": "string",
    "vipNetwork": "string",
    "id": "string",
    "tierNicIndex": 0,
    "loggingLevel": "string",
    "monitors": [
        {
            "receive": "string",
            "maxRetries": 0,
            "method": "string",
            "newEntity": false,
            "interval": 0,
            "id": "string",
            "monitorPath": "string",
            "send": "string",
            "timeout": 0,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ]
}
string
loadBalancerTypeId
Optional

loadBalancerTypeId

string
description
Optional

description

string
externalId
Optional

externalId

array of LoadBalancerPool
pools
Required

pools

integer As int32 As int32
vipNicIndex
Optional

vipNicIndex

string
tierNetwork
Optional

tierNetwork

literalMap
extensionData
Required

extensionData

array of LoadBalancerVirtualIp
virtualIps
Required

virtualIps

string
name
Optional

name

string
tenantId
Optional

tenantId

string
vipNetwork
Optional

vipNetwork

string
id
Optional

id

integer As int32 As int32
tierNicIndex
Optional

tierNicIndex

string
loggingLevel
Optional

loggingLevel

array of LoadBalancerMonitor
monitors
Required

monitors


On This Page
Network Component Operations
POST
Add A list Of security policies To An on-demand security group
POST
Apply To Machine Security Tags
POST
Assign the security group To the specified machine(s)
POST
Create Network
POST
Create Security Group
DELETE
Delete Network
DELETE
Delete Security Group
GET
Get Load Balancer
GET
Get Network
GET
Get Security Group
GET
Get Security Policy
GET
Get Security Tags
GET
List Load Balancers
GET
List Networks
GET
List Security Groups
GET
List Security Groups For Tenant
GET
List Security Policy
GET
List Security Policy For Tenant
GET
List Security Tags
GET
List Security Tags For Tenant
PUT
Update Security Group
PUT
Update Security Policy
PUT
Update Security Tag