This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

ListLoadbalancers

1 - 1.3

scpcli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

get Load Balancer list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

2 - 1.2

scpcli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

get Load Balancer list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260319

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

3 - 1.1

scpcli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

get Load Balancer list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260319

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID