Path parameters

• id string(uuid) Required
• service-id string(uuid) Required

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • description string

    Load Balancer Service description

    Maximum length is 255.

  • protocol string

    Network traffic protocol

    Values are tcp or udp.

  • name string

    Load Balancer Service name

    Minimum length is 1, maximum length is 255.

  • state string

    Load Balancer Service state

    Values are creating, deleting, running, updating, or error.

  • target-port integer(int64)

    Port on which the network traffic will be forwarded to on the receiving instance

    Minimum value is 0.

  • port integer(int64)

    Port exposed on the Load Balancer's public IP

    Minimum value is 0.

  • instance-pool object

    Instance Pool

    Hide instance-pool attributes Show instance-pool attributes object

    • application-consistent-snapshot-enabled boolean

      Enable application consistent snapshots

    • anti-affinity-groups array[object]

      Instance Pool Anti-affinity Groups

      Anti-affinity group reference

      Hide anti-affinity-groups attribute Show anti-affinity-groups attribute object

      • id string(uuid)

        Anti-affinity group ID

    • description string

      Instance Pool description

      Minimum length is 1, maximum length is 255.

    • public-ip-assignment string

      Values are inet4, dual, or none.

    • labels object
      Hide labels attribute Show labels attribute object

      • * string Additional properties
    • security-groups array[object]

      Instance Pool Security Groups

      Security group reference

      Hide security-groups attribute Show security-groups attribute object

      • id string(uuid)

        Security group ID

    • elastic-ips array[object]

      Instances Elastic IPs

      Elastic IP reference

      Hide elastic-ips attribute Show elastic-ips attribute object

      • id string(uuid)

        Elastic IP ID

    • name string

      Instance Pool name

      Minimum length is 1, maximum length is 255.

    • instance-type object

      Instance type reference

      Hide instance-type attribute Show instance-type attribute object

      • id string(uuid)

        Instance type ID

    • min-available integer(int64)

      Minimum number of running instances

      Minimum value is 0.

    • private-networks array[object]

      Instance Pool Private Networks

      Private network reference

      Hide private-networks attribute Show private-networks attribute object

      • id string(uuid)

        Private network ID

    • template object

      Template reference

      Hide template attribute Show template attribute object

      • id string(uuid)

        Template ID

    • state string

      Instance Pool state

      Values are scaling-up, scaling-down, destroying, creating, suspended, running, or updating.

    • size integer(int64)

      Number of instances

      Minimum value is 0.

    • ssh-key object

      SSH key reference

      Hide ssh-key attribute Show ssh-key attribute object

      • name string

        SSH key name

        Minimum length is 1, maximum length is 255.

    • instance-prefix string

      The instances created by the Instance Pool will be prefixed with this value (default: pool)

      Minimum length is 1, maximum length is 30.

    • user-data string

      Instances Cloud-init user-data

      Minimum length is 1.

    • manager object

      Resource manager

      Hide manager attributes Show manager attributes object

      • id string(uuid)

        Manager ID

      • type string

        Manager type

        Values are sks-nodepool or instance-pool.

    • instances array[object]

      Instances

      Target Instance

      Hide instances attribute Show instances attribute object

      • id string(uuid)

        Instance ID

    • deploy-target object

      Deploy target reference

      Hide deploy-target attribute Show deploy-target attribute object

      • id string(uuid)

        Deploy target ID

    • ipv6-enabled boolean

      Enable IPv6 for instances

    • id string(uuid)

      Instance Pool ID

    • disk-size integer(int64)

      Instances disk size in GiB

      Minimum value is 10, maximum value is 51200.

    • ssh-keys array[object]

      Instances SSH keys

      SSH key reference

      Hide ssh-keys attribute Show ssh-keys attribute object

      • name string

        SSH key name

        Minimum length is 1, maximum length is 255.

  • strategy string

    Load balancing strategy

    Values are round-robin, maglev-hash, or source-hash.

  • healthcheck object

    Load Balancer Service healthcheck

    Hide healthcheck attributes Show healthcheck attributes object

    • mode string

      Healthcheck mode

      Values are tcp, http, or https.

    • interval integer(int64)

      Healthcheck interval (default: 10). Must be greater than or equal to Timeout

      Minimum value is 5, maximum value is 300.

    • uri string

      An endpoint to use for the HTTP healthcheck, e.g. '/status'

      Minimum length is 1, maximum length is 255.

    • port integer(int64)

      Healthcheck port

      Minimum value is 1, maximum value is 65535.

    • timeout integer(int64)

      Healthcheck timeout value (default: 2). Must be lower than or equal to Interval

      Minimum value is 2, maximum value is 60.

    • retries integer(int64)

      Number of retries before considering a Service failed

      Minimum value is 1, maximum value is 20.

    • tls-sni string

      SNI domain for HTTPS healthchecks

      Minimum length is 1, maximum length is 255.

  • id string(uuid)

    Load Balancer Service ID

  • healthcheck-status array[object]

    Healthcheck status per backend server

    Load Balancer Service status

    Hide healthcheck-status attributes Show healthcheck-status attributes object

    • public-ip string(ipv4)

      Backend server public IP

    • status string

      Status of the instance's healthcheck

      Values are failure or success.