API
Load Balancers
Load balancer model

Load Balancer Model

  • Name
    ip
    Type
    string
    Description

    The load balancer public-facing IP address.

  • Name
    uuid
    Type
    string
    Description

    Unique identifier for the load balancer.

  • Name
    name
    Type
    string
    Description

    Human readable name for the load balancer.

  • Name
    task
    Type
    object
    Description

    Current status of the task or null if the task doesn't exist.

  • Name
    rules
    Type
    array
    Description

    Forwarding rules for the load balancer.

  • Name
    health
    Type
    object
    Description

    Health check settings for the load balancer.

  • Name
    region
    Type
    object
    Description

    The region name where the load balancer is located.

  • Name
    algorithm
    Type
    string
    Description

    The load balancing algorithm used to determine which backend Stacklet will be selected by the client. It must be either "round_robin" or least_connections.

  • Name
    created_at
    Type
    string
    Description

    The date and time in ISO 8601 formats of when the load balancer was created.

  • Name
    stacklet_ids
    Type
    array
    Description

    The stacklets ids where the load balancer will be assigned.

  • Name
    sticky_sessions
    Type
    object
    Description

    Sticky sessions settings for the load balancer.

  • Name
    redirect_http_to_https
    Type
    boolean
    Description

    A value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443.

Health Model

When the health object is returned, health checks are used to tell if a Stacklet is responding and should receive traffic. The load balancer will automatically stop sending traffic to the unresponsive Stacklets. The User may specify the protocol, port, and path for a health check as well as additional setting such as the check interval and response timeout. The following are the returned attributes:

  • Name
    path
    Type
    string
    Description

    The path on the backend Stacklets to which the load balancer instance will send a request.

  • Name
    port
    Type
    integer
    Description

    The port on the backend Stacklets on which the health check will attempt a connection.

  • Name
    rise
    Type
    integer
    Description

    The number of times a health check must pass for a backend Stacklet to be marked "healthy" and be re-added to the pool.

  • Name
    fall
    Type
    integer
    Description

    The number of times a health check must fail for a backend Stacklet to be marked "unhealthy" and be removed from the pool.

  • Name
    interval
    Type
    integer
    Description

    The number of seconds between two consecutive health checks.

  • Name
    protocol
    Type
    integer
    Description

    The protocol which the health checks use in order to sent connection attempt to the backend Stacklets. The possible values are: http or tcp.

Rule Model

When the rules object is returned, the Forwarding rules determine how traffic will be routed from the load balancer to the Stacklets assigned to it. They can be used to configure the type of traffic (HTTP, HTTPS, or TCP) and to map ports on the load balancer to ports on the Stacklets. For SSL encrypted traffic, the user may also configure whether to use SSL termination at the load balancer (by specifying an SSL certificate) or to pass the encrypted traffic through to the Stacklet. The following are the returned attributes:

  • Name
    protocol
    Type
    string
    Description

    The protocol of the traffic directed to the load balancer. Possible values are: "http", "https", "http2", or "tcp".

  • Name
    source_port
    Type
    integer
    Description

    The port on which the load balancer instance will listen.

  • Name
    target_port
    Type
    integer
    Description

    The port on the backend Stacklets to which the load balancer will send traffic to.

  • Name
    certificate_id
    Type
    integer
    Description

    The ID of the TLS certificate used for SSL termination if enabled. The value will be null if there is no certificate enabled.

  • Name
    tls_passthrough
    Type
    boolean
    Description

    A value indicating whether the SSL encrypted traffic will be passed through to the backend Stacklets.

Sticky Sessions Model

When sticky_sessions object is returned, that means sticky sessions are in use, follow up requests from the client will be sent to the same Stacklet as the original request. Both the name of the cookie and the TTL are configurable as follow:

  • Name
    name
    Type
    string
    Description

    The name of the load balancer cookie sent to the client. This attribute is only returned when using cookies for the sticky sessions type.

  • Name
    ttl
    Type
    string
    Description

    The number of seconds until the load balancer cookie expires. This attribute is only returned when using cookie for the sticky sessions type.

OverviewCreate load balancer