LoadBalancer

LoadBalancer
LoadBalancer

Represents a load balancer.
HATEOAS links:
load-balancer-targets - array[Machine] - List of load balancer target machines.
cloud-account - CloudAccount - Cloud account where this LB is deployed.
self - LoadBalancer - Self link to this load balancer

JSON Example 
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "projectId": "9e49",
    "externalZoneId": "us-east-1a",
    "externalRegionId": "us-east-1",
    "cloudAccountIds": [
        "string"
    ],
    "address": "lb-123456789.eu-west-1.elb.amazonaws.com",
    "routes": [
        {
            "protocol": "TCP, UDP",
            "port": "80",
            "memberProtocol": "TCP, UDP",
            "memberPort": "80",
            "healthCheckConfiguration": {
                "protocol": "HTTP, HTTPS",
                "port": "80",
                "urlPath": "/index.html",
                "intervalSeconds": 60,
                "timeoutSeconds": 5,
                "unhealthyThreshold": 5,
                "healthyThreshold": 2
            }
        }
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user that owns the entity.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

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

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
projectId
Optional

The id of the project this entity belongs to.

string
externalZoneId
Required

The external zoneId of the resource.

string
externalRegionId
Required

The external regionId of the resource

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.

string
address
Optional

Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.

array of RouteConfiguration
routes
Required

The load balancer route configuration regarding ports and protocols.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this load balancer.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

Property Of
Returned By