ByCloud Docs
GuidesCLIAPISDK

Python SDK

Load Balancers

Load balancers, listeners, pools, and health monitors

35 methods

GET

list_load_balancers()

List load balancers

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

tags

string

- Filter by tags (comma-separated)

vip_subnet_id

string

- Filter by VIP subnet ID

vip_address

string

- Filter by VIP address

provisioning_status

string

- Filter by provisioning status

operating_status

string

- Filter by operating status

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_load_balancers()
print(result)
POST

create_load_balancer()

Create load balancer

Parameters

name

string

required
description

string

vip_address

string

- VIP address (auto-assigned if omitted)

vip_subnet_id

string

required
vip_network_id

string

flavor_id

string

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_load_balancer(name="web-lb", vip_subnet_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

get_load_balancer()

Get load balancer

Parameters

load_balancer_id

string

required

- Load Balancer ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_load_balancer(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_load_balancer()

Update load balancer

Parameters

load_balancer_id

string

required

- Load Balancer ID

name

string

description

string

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_load_balancer(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_load_balancer()

Delete load balancer

Parameters

load_balancer_id

string

required

- Load Balancer ID

cascade

boolean

- Delete all child resources (listeners, pools, etc.)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_load_balancer(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_health_monitors()

List health monitors

Parameters

load_balancer_id

string

required

- Load Balancer ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

tags

string

- Filter by tags (comma-separated)

pool_id

string

- Filter by pool ID

type

string

- Filter by health monitor type

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_health_monitors(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_health_monitor()

Create health monitor

Parameters

load_balancer_id

string

required

- Load Balancer ID

name

string

pool_id

string

required
type

string

required
delay

integer

required
timeout

integer

required
max_retries

integer

required
max_retries_down

integer

http_method

string

url_path

string

expected_codes

string

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_health_monitor(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000", type="HTTP", delay=10, timeout=10, max_retries=10)
print(result)
GET

get_health_monitor()

Get health monitor

Parameters

load_balancer_id

string

required

- Load Balancer ID

health_monitor_id

string

required

- Health Monitor ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_health_monitor(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", health_monitor_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_health_monitor()

Update health monitor

Parameters

load_balancer_id

string

required

- Load Balancer ID

health_monitor_id

string

required

- Health Monitor ID

name

string

delay

integer

timeout

integer

max_retries

integer

max_retries_down

integer

http_method

string

url_path

string

expected_codes

string

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_health_monitor(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", health_monitor_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_health_monitor()

Delete health monitor

Parameters

load_balancer_id

string

required

- Load Balancer ID

health_monitor_id

string

required

- Health Monitor ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_health_monitor(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", health_monitor_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_l7policies()

List L7 policies

Parameters

load_balancer_id

string

required

- Load Balancer ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

tags

string

- Filter by tags (comma-separated)

listener_id

string

- Filter by listener ID

action

string

- Filter by action

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_l7policies(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_l7policy()

Create L7 policy

Parameters

load_balancer_id

string

required

- Load Balancer ID

name

string

description

string

listener_id

string

required
action

string

required
position

integer

redirect_pool_id

string

- Required for REDIRECT_TO_POOL action

redirect_url

string

- Required for REDIRECT_TO_URL action

redirect_prefix

string

- Required for REDIRECT_PREFIX action

redirect_http_code

integer

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_l7policy(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", listener_id="550e8400-e29b-41d4-a716-446655440000", action="REDIRECT_TO_POOL")
print(result)
GET

get_l7policy()

Get L7 policy

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_l7policy(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_l7policy()

Update L7 policy

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

name

string

description

string

action

string

position

integer

redirect_pool_id

string

redirect_url

string

redirect_prefix

string

redirect_http_code

integer

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_l7policy(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_l7policy()

Delete L7 policy

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_l7policy(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_l7rules()

List L7 rules

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_l7rules(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_l7rule()

Create L7 rule

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

type

string

required
compare_type

string

required
key

string

- Required for HEADER and COOKIE rules

value

string

required
invert

boolean

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_l7rule(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000", type="PATH", compare_type="STARTS_WITH", value="example-string")
print(result)
GET

get_l7rule()

Get L7 rule

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

l7_rule_id

string

required

- L7 Rule ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_l7rule(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000", l7_rule_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_l7rule()

Update L7 rule

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

l7_rule_id

string

required

- L7 Rule ID

type

string

compare_type

string

key

string

value

string

invert

boolean

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_l7rule(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000", l7_rule_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_l7rule()

Delete L7 rule

Parameters

load_balancer_id

string

required

- Load Balancer ID

l7_policy_id

string

required

- L7 Policy ID

l7_rule_id

string

required

- L7 Rule ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_l7rule(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", l7_policy_id="550e8400-e29b-41d4-a716-446655440000", l7_rule_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_listeners()

List listeners

Parameters

load_balancer_id

string

required

- Load Balancer ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

tags

string

- Filter by tags (comma-separated)

protocol

string

- Filter by protocol

protocol_port

integer

- Filter by protocol port

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_listeners(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_listener()

Create listener

Parameters

load_balancer_id

string

required

- Load Balancer ID

name

string

description

string

load_balancer_id

string

protocol

string

required
protocol_port

integer

required
connection_limit

integer

default_pool_id

string

default_tls_container_ref

string

sni_container_refs

array

insert_headers

object

timeout_client_data

integer

timeout_member_connect

integer

timeout_member_data

integer

timeout_tcp_inspect

integer

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_listener(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", protocol="HTTP", protocol_port=10)
print(result)
GET

get_listener()

Get listener

Parameters

load_balancer_id

string

required

- Load Balancer ID

listener_id

string

required

- Listener ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_listener(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", listener_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_listener()

Update listener

Parameters

load_balancer_id

string

required

- Load Balancer ID

listener_id

string

required

- Listener ID

name

string

description

string

connection_limit

integer

default_pool_id

string

default_tls_container_ref

string

sni_container_refs

array

insert_headers

object

timeout_client_data

integer

timeout_member_connect

integer

timeout_member_data

integer

timeout_tcp_inspect

integer

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_listener(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", listener_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_listener()

Delete listener

Parameters

load_balancer_id

string

required

- Load Balancer ID

listener_id

string

required

- Listener ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_listener(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", listener_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_pools()

List pools

Parameters

load_balancer_id

string

required

- Load Balancer ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

tags

string

- Filter by tags (comma-separated)

protocol

string

- Filter by protocol

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_pools(load_balancer_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_pool()

Create pool

Parameters

load_balancer_id

string

required

- Load Balancer ID

name

string

description

string

load_balancer_id

string

listener_id

string

- Listener to attach (optional)

protocol

string

required
lb_algorithm

string

required
session_persistence

object

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_pool(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", protocol="HTTP", lb_algorithm="ROUND_ROBIN")
print(result)
GET

get_pool()

Get pool

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_pool(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_pool()

Update pool

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

name

string

description

string

lb_algorithm

string

session_persistence

object

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_pool(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_pool()

Delete pool

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_pool(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_pool_members()

List pool members

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.list_pool_members(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_pool_member()

Create pool member

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

name

string

address

string

required
protocol_port

integer

required
weight

integer

subnet_id

string

monitor_address

string

monitor_port

integer

backup

boolean

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.create_pool_member(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000", address="example-string", protocol_port=10)
print(result)
GET

get_pool_member()

Get pool member

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

member_id

string

required

- Pool Member ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.get_pool_member(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000", member_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_pool_member()

Update pool member

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

member_id

string

required

- Pool Member ID

name

string

weight

integer

monitor_address

string

monitor_port

integer

backup

boolean

tags

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.update_pool_member(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000", member_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_pool_member()

Delete pool member

Parameters

load_balancer_id

string

required

- Load Balancer ID

pool_id

string

required

- Pool ID

member_id

string

required

- Pool Member ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.load_balancers.delete_pool_member(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", pool_id="550e8400-e29b-41d4-a716-446655440000", member_id="550e8400-e29b-41d4-a716-446655440000")
print(result)