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

Return to the regular view of this page.

Load Balancer

1: CLIs

1.1: AddLbServerGroupMembers

1.1.1: 1.3
1.1.2: 1.2
1.1.3: 1.1

1.2: CreateLBHealthCheck

1.2.1: 1.3
1.2.2: 1.2
1.2.3: 1.1

1.3: CreateLbListener

1.3.1: 1.3
1.3.2: 1.2
1.3.3: 1.1

1.4: CreateLBServerGroup

1.4.1: 1.3
1.4.2: 1.2
1.4.3: 1.1

1.5: CreateLoadbalancer

1.5.1: 1.3
1.5.2: 1.2
1.5.3: 1.1

1.6: CreateLoadbalancerPrivateNatIp

1.6.1: 1.3

1.7: CreateLoadbalancerPublicNatIp

1.7.1: 1.3
1.7.2: 1.2
1.7.3: 1.1

1.8: DeleteLBHealthCheck

1.8.1: 1.3
1.8.2: 1.2
1.8.3: 1.1

1.9: DeleteLbListener

1.9.1: 1.3
1.9.2: 1.2
1.9.3: 1.1

1.10: DeleteLBServerGroup

1.10.1: 1.3
1.10.2: 1.2
1.10.3: 1.1

1.11: DeleteLoadbalancer

1.11.1: 1.3
1.11.2: 1.2
1.11.3: 1.1

1.12: DeleteLoadbalancerPrivateNatIp

1.12.1: 1.3

1.13: DeleteLoadbalancerPublicNatIp

1.13.1: 1.3
1.13.2: 1.2
1.13.3: 1.1

1.14: ListLBHealthChecks

1.14.1: 1.3
1.14.2: 1.2
1.14.3: 1.1

1.15: ListLbListeners

1.15.1: 1.3
1.15.2: 1.2
1.15.3: 1.1

1.16: ListLbServerGroupMembers

1.16.1: 1.3
1.16.2: 1.2
1.16.3: 1.1

1.17: ListLBServerGroups

1.17.1: 1.3
1.17.2: 1.2
1.17.3: 1.1

1.18: ListLoadbalancerCertificates

1.18.1: 1.3
1.18.2: 1.2
1.18.3: 1.1

1.19: ListLoadbalancers

1.19.1: 1.3
1.19.2: 1.2
1.19.3: 1.1

1.20: RemoveLbServerGroupMember

1.20.1: 1.3
1.20.2: 1.2
1.20.3: 1.1

1.21: RemoveLbServerGroupMembers

1.21.1: 1.3
1.21.2: 1.2

1.22: SetLBHealthCheck

1.22.1: 1.3
1.22.2: 1.2
1.22.3: 1.1

1.23: SetLbListener

1.23.1: 1.3
1.23.2: 1.2
1.23.3: 1.1

1.24: SetLBServerGroup

1.24.1: 1.3
1.24.2: 1.2
1.24.3: 1.1

1.25: SetLbServerGroupMember

1.25.1: 1.3
1.25.2: 1.2
1.25.3: 1.1

1.26: SetLoadbalancer

1.26.1: 1.3
1.26.2: 1.2
1.26.3: 1.1

1.27: ShowLBHealthCheck

1.27.1: 1.3
1.27.2: 1.2
1.27.3: 1.1

1.28: ShowLbListener

1.28.1: 1.3
1.28.2: 1.2
1.28.3: 1.1

1.29: ShowLBServerGroup

1.29.1: 1.3
1.29.2: 1.2
1.29.3: 1.1

1.30: ShowLbServerGroupMember

1.30.1: 1.3
1.30.2: 1.2
1.30.3: 1.1

1.31: ShowLoadbalancer

1.31.1: 1.3
1.31.2: 1.2
1.31.3: 1.1

1.32: ShowLoadbalancerCertificate

1.32.1: 1.3
1.32.2: 1.2
1.32.3: 1.1

1.33: ShowLoadbalancerPrivateNatIp

1.33.1: 1.3

1.34: ShowLoadbalancerPublicNatIp

1.34.1: 1.3
1.34.2: 1.2
1.34.3: 1.1

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of LOADBALANCER service and how to call CLI. The output is formatted as a JSON string

Version

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

Version	Status	Not Before
1.3	CURRENT	-
1.2	DEPRECATED	20260319
1.1	DEPRECATED	20260319
1.0	DEPRECATED	20251023

1 - CLIs

1.1 - AddLbServerGroupMembers

1.1.1 - 1.3

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
members required	array		`'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_id	ID of Lb Server Group
member_ip	IP of Member
member_port	Protocol port of Member
member_state	Member State of Member
member_weight	Weight of Member
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of Member
object_id	Object ID of Member
object_type	Object Type of Member
state	State of Member
subnet_id	ID of Subnet
uuid	UUID of Member

1.1.2 - 1.2

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
members required	array		`'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_id	ID of Lb Server Group
member_ip	IP of Member
member_port	Protocol port of Member
member_state	Member State of Member
member_weight	Weight of Member
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of Member
object_id	Object ID of Member
object_type	Object Type of Member
state	State of Member
subnet_id	ID of Subnet
uuid	UUID of Member

1.1.3 - 1.1

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
members required	array		`'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_id	ID of Lb Server Group
member_ip	IP of Member
member_port	Protocol port of Member
member_state	Member State of Member
member_weight	Weight of Member
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of Member
object_id	Object ID of Member
object_type	Object Type of Member
state	State of Member
subnet_id	ID of Subnet
uuid	UUID of Member

1.2 - CreateLBHealthCheck

1.2.1 - 1.3

scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

Create LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
subnet_id required	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
protocol required	string	LB Health Check Protocol	`TCP`
name required	string	LB Health Check name	`ServerGroup01`
description optional	string	Description	`this is an lb server group`
health_check_count optional	integer	LB Health Check count	`3`
health_check_interval optional	integer	LB Health Check interval	`5`
health_check_port optional	integer	LB Health Check port	`80`
health_check_timeout optional	integer	LB Health Check timeout	`5`
health_check_url optional	string	LB Health Check URL	`/test`
http_method optional	****	LB Health Check HTTP Method	`GET`
request_data optional	string	LB Health Check Request data	`username=admin&password=1234`
response_code optional	string	LB Health Check Response code	`200`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
health_check_count	LB Health Check count	3
health_check_interval	LB Health Check interval	5
health_check_port	LB Health Check port	80
health_check_timeout	LB Health Check timeout	5
health_check_type	LB Health Check type	DEFAULT
health_check_url	LB Health Check URL	/test
http_method	LB Health Check HTTP Method	GET
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
request_data	LB Health Check Request data	username=admin&password=1234
response_code	LB Health Check Response code	200
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.2.2 - 1.2

scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

Create LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
subnet_id required	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
protocol required	string	LB Health Check Protocol	`TCP`
name required	string	LB Health Check name	`ServerGroup01`
description optional	string	Description	`this is an lb server group`
health_check_count optional	integer	LB Health Check count	`3`
health_check_interval optional	integer	LB Health Check interval	`5`
health_check_port optional	integer	LB Health Check port	`80`
health_check_timeout optional	integer	LB Health Check timeout	`5`
health_check_url optional	string	LB Health Check URL	`/test`
http_method optional	****	LB Health Check HTTP Method	`GET`
request_data optional	string	LB Health Check Request data	`username=admin&password=1234`
response_code optional	string	LB Health Check Response code	`200`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
health_check_count	LB Health Check count	3
health_check_interval	LB Health Check interval	5
health_check_port	LB Health Check port	80
health_check_timeout	LB Health Check timeout	5
health_check_type	LB Health Check type	DEFAULT
health_check_url	LB Health Check URL	/test
http_method	LB Health Check HTTP Method	GET
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
request_data	LB Health Check Request data	username=admin&password=1234
response_code	LB Health Check Response code	200
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.2.3 - 1.1

scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

Create LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
subnet_id required	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
protocol required	string	LB Health Check Protocol	`TCP`
name required	string	LB Health Check name	`ServerGroup01`
description optional	string	Description	`this is an lb server group`
health_check_count optional	integer	LB Health Check count	`3`
health_check_interval optional	integer	LB Health Check interval	`5`
health_check_port optional	integer	LB Health Check port	`80`
health_check_timeout optional	integer	LB Health Check timeout	`5`
health_check_url optional	string	LB Health Check URL	`/test`
http_method optional	****	LB Health Check HTTP Method	`GET`
request_data optional	string	LB Health Check Request data	`username=admin&password=1234`
response_code optional	string	LB Health Check Response code	`200`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
health_check_count	LB Health Check count	3
health_check_interval	LB Health Check interval	5
health_check_port	LB Health Check port	80
health_check_timeout	LB Health Check timeout	5
health_check_type	LB Health Check type	DEFAULT
health_check_url	LB Health Check URL	/test
http_method	LB Health Check HTTP Method	GET
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
request_data	LB Health Check Request data	username=admin&password=1234
response_code	LB Health Check Response code	200
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.3 - CreateLbListener

1.3.1 - 1.3

scpcli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--hsts_max_age <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]

Description

create LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
listener_protocol required	string	protocol	-
service_port required	integer	The port of the listener.	-
routing_action required	string	The routing action of the listener.	-
name required	string	The name of the listener.	-
loadbalancer_id required	string	The ID of the load balancer.	-
condition_type optional	****	The condition type of the listener.	-
description optional	string	description	-
hsts_max_age optional	integer	The hsts_max_age of the listener.	-
idle_timeout optional	integer	The idle timeout(L7) of the listener.	-
insert_client_ip optional	boolean	Whether the client IP should be inserted.	-
persistence optional	string	The persistence of the listener.	-
response_timeout optional	integer	The response timeout of the listener.	-
server_group_id optional	string	The ID of the server group.	-
session_duration_time optional	integer	The session duration time.	-
sni_certificate optional	array	The sni certificate of the listener.	`'{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}'`
support_http2 optional	boolean	Whether the HTTP 2.0 is supported	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
url_handler optional	array	The URL handler of the listener.	-
url_redirection optional	string	The URL redirect of the listener.	-
x_forwarded_for optional	boolean	Whether the X-Forwarded-For should be inserted.	-
x_forwarded_port optional	boolean	Whether the X-Forwarded-Port should be inserted.	-
x_forwarded_proto optional	boolean	Whether the X-Forwarded-Protocol should be inserted.	-
port optional	string	port	-
response_code optional	string	response_code	-
client_cert_id optional	string	Certificate id for client ssl	-
client_cert_level optional	string	Certificate level for client ssl	-
server_cert_level optional	string	Certificate level for server ssl	-
listener_https_redirection_protocol optional	string	protocol	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_type	The condition type of the listener.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
hsts_max_age	The hsts_max_age of the listener.
https_redirection	The https redirection of the listener.
idle_timeout	The idle timeout(L7) of the listener.
insert_client_ip	Whether the client IP should be inserted.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
persistence	The persistence of the listener.
protocol	The protocol of the listener.
response_timeout	The response timeout of the listener.
routing_action	The routing action of the listener.
server_group_id	The ID of the server group.
server_group_name	The Name of the server group.
service_port	The port of the listener.
session_duration_time	The session duration time.
sni_certificate	The sni certificate of the listener.
ssl_certificate	The ssl certificate of the listener.
state	The State of the listener.
support_http2	Whether the HTTP 2.0 is supported
url_handler	The URL handler of the listener.
url_redirection	The URL redirect of the listener.
x_forwarded_for	Whether the X-Forwarded-For should be inserted.
x_forwarded_port	Whether the X-Forwarded-Port should be inserted.
x_forwarded_proto	Whether the X-Forwarded-Protocol should be inserted.

1.3.2 - 1.2

scpcli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]

Description

create LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
listener_protocol required	string	protocol	-
service_port required	integer	The port of the listener.	-
routing_action required	string	The routing action of the listener.	-
name required	string	The name of the listener.	-
loadbalancer_id required	string	The ID of the load balancer.	-
condition_type optional	****	The condition type of the listener.	-
description optional	string	description	-
insert_client_ip optional	boolean	Whether the client IP should be inserted.	-
persistence optional	string	The persistence of the listener.	-
response_timeout optional	integer	The response timeout of the listener.	-
server_group_id optional	string	The ID of the server group.	-
session_duration_time optional	integer	The session duration time.	-
sni_certificate optional	array	The sni certificate of the listener.	`'{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}'`
support_http2 optional	boolean	Whether the HTTP 2.0 is supported	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
url_handler optional	array	The URL handler of the listener.	-
url_redirection optional	string	The URL redirect of the listener.	-
x_forwarded_for optional	boolean	Whether the X-Forwarded-For should be inserted.	-
x_forwarded_port optional	boolean	Whether the X-Forwarded-Port should be inserted.	-
x_forwarded_proto optional	boolean	Whether the X-Forwarded-Protocol should be inserted.	-
port optional	string	port	-
response_code optional	string	response_code	-
client_cert_id optional	string	Certificate id for client ssl	-
client_cert_level optional	string	Certificate level for client ssl	-
server_cert_level optional	string	Certificate level for server ssl	-
listener_https_redirection_protocol optional	string	protocol	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_type	The condition type of the listener.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
https_redirection	The https redirection of the listener.
insert_client_ip	Whether the client IP should be inserted.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
persistence	The persistence of the listener.
protocol	The protocol of the listener.
response_timeout	The response timeout of the listener.
routing_action	The routing action of the listener.
server_group_id	The ID of the server group.
server_group_name	The Name of the server group.
service_port	The port of the listener.
session_duration_time	The session duration time.
sni_certificate	The sni certificate of the listener.
ssl_certificate	The ssl certificate of the listener.
state	The State of the listener.
support_http2	Whether the HTTP 2.0 is supported
url_handler	The URL handler of the listener.
url_redirection	The URL redirect of the listener.
x_forwarded_for	Whether the X-Forwarded-For should be inserted.
x_forwarded_port	Whether the X-Forwarded-Port should be inserted.
x_forwarded_proto	Whether the X-Forwarded-Protocol should be inserted.

1.3.3 - 1.1

scpcli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--routing_action <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]

Description

create LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
listener_protocol required	string	protocol	-
service_port required	integer	The port of the listener.	-
name required	string	The name of the listener.	-
loadbalancer_id required	string	The ID of the load balancer.	-
condition_type optional	****	The condition type of the listener.	-
description optional	string	description	-
insert_client_ip optional	boolean	Whether the client IP should be inserted.	-
persistence optional	string	The persistence of the listener.	-
response_timeout optional	integer	The response timeout of the listener.	-
routing_action optional	****	The routing action of the listener.	-
server_group_id optional	string	The ID of the server group.	-
session_duration_time optional	integer	The session duration time.	-
sni_certificate optional	array	The sni certificate of the listener.	`'{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}'`
support_http2 optional	boolean	Whether the HTTP 2.0 is supported	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
url_handler optional	array	The URL handler of the listener.	-
url_redirection optional	string	The URL redirect of the listener.	-
x_forwarded_for optional	boolean	Whether the X-Forwarded-For should be inserted.	-
x_forwarded_port optional	boolean	Whether the X-Forwarded-Port should be inserted.	-
x_forwarded_proto optional	boolean	Whether the X-Forwarded-Protocol should be inserted.	-
port optional	string	port	-
response_code optional	string	response_code	-
client_cert_id optional	string	Certificate id for client ssl	-
client_cert_level optional	string	Certificate level for client ssl	-
server_cert_level optional	string	Certificate level for server ssl	-
listener_https_redirection_protocol optional	string	protocol	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_type	The condition type of the listener.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
https_redirection	The https redirection of the listener.
insert_client_ip	Whether the client IP should be inserted.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
persistence	The persistence of the listener.
protocol	The protocol of the listener.
response_timeout	The response timeout of the listener.
routing_action	The routing action of the listener.
server_group_id	The ID of the server group.
server_group_name	The Name of the server group.
service_port	The port of the listener.
session_duration_time	The session duration time.
sni_certificate	The sni certificate of the listener.
ssl_certificate	The ssl certificate of the listener.
state	The State of the listener.
support_http2	Whether the HTTP 2.0 is supported
url_handler	The URL handler of the listener.
url_redirection	The URL redirect of the listener.
x_forwarded_for	Whether the X-Forwarded-For should be inserted.
x_forwarded_port	Whether the X-Forwarded-Port should be inserted.
x_forwarded_proto	Whether the X-Forwarded-Protocol should be inserted.

1.4 - CreateLBServerGroup

1.4.1 - 1.3

scpcli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

Create LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
subnet_id required	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
protocol required	string	Protocol	`TCP`
name required	string	LB Health Check name	`ServerGroup01`
lb_method required	string	LB Method	`ROUND_ROBIN`
description optional	string	Description	`this is an lb server group`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_method	LB Method	ROUND_ROBIN
lb_name	Load Balancer name	Test-LB-01
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.4.2 - 1.2

scpcli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

Create LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
subnet_id required	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
protocol required	string	Protocol	`TCP`
name required	string	LB Health Check name	`ServerGroup01`
lb_method required	string	LB Method	`ROUND_ROBIN`
description optional	string	Description	`this is an lb server group`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_method	LB Method	ROUND_ROBIN
lb_name	Load Balancer name	Test-LB-01
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.4.3 - 1.1

scpcli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

Create LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
subnet_id required	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
protocol required	string	Protocol	`TCP`
name required	string	LB Health Check name	`ServerGroup01`
lb_method required	string	LB Method	`ROUND_ROBIN`
description optional	string	Description	`this is an lb server group`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_method	LB Method	ROUND_ROBIN
lb_name	Load Balancer name	Test-LB-01
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.5 - CreateLoadbalancer

1.5.1 - 1.3

scpcli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]

Description

create Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	-
subnet_id required	string	Subnet ID	-
name required	string	name	-
layer_type required	string	Layer type	-
description optional	string	description	-
firewall_enabled optional	boolean	Firewall enabled	-
firewall_logging_enabled optional	boolean	Firewall logging enabled	-
health_check_ip_1 optional	string	Health check IP	-
health_check_ip_2 optional	string	Health check IP	-
publicip_id optional	string	Public IP ID	-
service_ip optional	string	The service IP of the load balancer.	-
source_nat_ip optional	string	Source NAT IP	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID
account_id	The account ID of the load balancer.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
layer_type	Layer type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.5.2 - 1.2

scpcli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]

Description

create Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	-
subnet_id required	string	Subnet ID	-
name required	string	name	-
layer_type required	string	Layer type	-
description optional	string	description	-
firewall_enabled optional	boolean	Firewall enabled	-
firewall_logging_enabled optional	boolean	Firewall logging enabled	-
health_check_ip_1 optional	string	Health check IP	-
health_check_ip_2 optional	string	Health check IP	-
publicip_id optional	string	Public IP ID	-
service_ip optional	string	The service IP of the load balancer.	-
source_nat_ip optional	string	Source NAT IP	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID
account_id	The account ID of the load balancer.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
layer_type	Layer type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.5.3 - 1.1

scpcli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]

Description

create Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC ID	-
subnet_id required	string	Subnet ID	-
name required	string	name	-
layer_type required	string	Layer type	-
description optional	string	description	-
firewall_enabled optional	boolean	Firewall enabled	-
firewall_logging_enabled optional	boolean	Firewall logging enabled	-
health_check_ip_1 optional	string	Health check IP	-
health_check_ip_2 optional	string	Health check IP	-
publicip_id optional	string	Public IP ID	-
service_ip optional	string	The service IP of the load balancer.	-
source_nat_ip optional	string	Source NAT IP	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID
account_id	The account ID of the load balancer.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
layer_type	Layer type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.6 - CreateLoadbalancerPrivateNatIp

1.6.1 - 1.3

scpcli loadbalancer loadbalancer-private-nat-ip create
--loadbalancer_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

create Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
private_nat_ip_id required	string	private_nat_ip_id	-
private_nat_id required	string	private_nat_id	-

Responses

Name	Description	Example
id	ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
external_ip_address	external_ip_address
internal_ip_address	internal_ip_address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
private_nat_ip_id	private_nat_ip_id
state	state
subnet_id	subnet_id

1.7 - CreateLoadbalancerPublicNatIp

1.7.1 - 1.3

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
publicip_id required	string	publicip_id	-

Responses

Name	Description	Example
id	ID
account_id	account_id
action_type	action_type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
external_ip_address	external_ip_address
internal_ip_address	internal_ip_address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
owner_id	owner_id
owner_name	owner_name
owner_type	owner_type
publicip_id	publicip_id
service_ip_port_id	service_ip_port_id
state	state
subnet_id	subnet_id
type	type
vpc_id	vpc_id

1.7.2 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
publicip_id required	string	publicip_id	-

Responses

Name	Description	Example
id	ID
account_id	account_id
action_type	action_type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
external_ip_address	external_ip_address
internal_ip_address	internal_ip_address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
owner_id	owner_id
owner_name	owner_name
owner_type	owner_type
publicip_id	publicip_id
service_ip_port_id	service_ip_port_id
state	state
subnet_id	subnet_id
type	type
vpc_id	vpc_id

1.7.3 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
publicip_id required	string	publicip_id	-

Responses

Name	Description	Example
id	ID
account_id	account_id
action_type	action_type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
external_ip_address	external_ip_address
internal_ip_address	internal_ip_address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
owner_id	owner_id
owner_name	owner_name
owner_type	owner_type
publicip_id	publicip_id
service_ip_port_id	service_ip_port_id
state	state
subnet_id	subnet_id
type	type
vpc_id	vpc_id

1.8 - DeleteLBHealthCheck

1.8.1 - 1.3

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`

1.8.2 - 1.2

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`

1.8.3 - 1.1

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`

1.9 - DeleteLbListener

1.9.1 - 1.3

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-

1.9.2 - 1.2

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-

1.9.3 - 1.1

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-

1.10 - DeleteLBServerGroup

1.10.1 - 1.3

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`

1.10.2 - 1.2

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`

1.10.3 - 1.1

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`

1.11 - DeleteLoadbalancer

1.11.1 - 1.3

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.11.2 - 1.2

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.11.3 - 1.1

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.12 - DeleteLoadbalancerPrivateNatIp

1.12.1 - 1.3

scpcli loadbalancer loadbalancer-private-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.13 - DeleteLoadbalancerPublicNatIp

1.13.1 - 1.3

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.13.2 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.13.3 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

1.14 - ListLBHealthChecks

1.14.1 - 1.3

scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

List LB Health Checks

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	LB Health Check name	`Test-LbMonitor-01`
protocol optional	array	LB Health Check Protocol	`'TCP'`
subnet_id optional	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
health_check_type	LB Health Check type	DEFAULT
lb_server_group_count	LB Server Group count	2
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200

1.14.2 - 1.2

scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

List LB Health Checks

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	LB Health Check name	`Test-LbMonitor-01`
protocol optional	array	LB Health Check Protocol	`'TCP'`
subnet_id optional	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
health_check_type	LB Health Check type	DEFAULT
lb_server_group_count	LB Server Group count	2
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200

1.14.3 - 1.1

scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

List LB Health Checks

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	LB Health Check name	`Test-LbMonitor-01`
protocol optional	array	LB Health Check Protocol	`'TCP'`
subnet_id optional	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
health_check_type	LB Health Check type	DEFAULT
lb_server_group_count	LB Server Group count	2
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200

1.15 - ListLbListeners

1.15.1 - 1.3

scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]

Description

get LB listener list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
loadbalancer_id optional	string	The ID of the load balancer.	-
state optional	string	The State of the listener.	-
name optional	string	The name of the listener.	-
service_port optional	integer	The port of the listener.	-
protocol optional	array	Protocol	`'TCP'`
not_protocol optional	****	The protocol of the listener to exclude.	`TCP`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
protocol	The protocol of the listener.
service_port	The port of the listener.
state	The State of the listener.

1.15.2 - 1.2

scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]

Description

get LB listener 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.

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
loadbalancer_id optional	string	The ID of the load balancer.	-
state optional	string	The State of the listener.	-
name optional	string	The name of the listener.	-
service_port optional	integer	The port of the listener.	-
protocol optional	array	Protocol	`'TCP'`
not_protocol optional	****	The protocol of the listener to exclude.	`TCP`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
protocol	The protocol of the listener.
service_port	The port of the listener.
state	The State of the listener.

1.15.3 - 1.1

scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]

Description

get LB listener 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.

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
loadbalancer_id optional	string	The ID of the load balancer.	-
state optional	string	The State of the listener.	-
name optional	string	The name of the listener.	-
service_port optional	integer	The port of the listener.	-
protocol optional	array	Protocol	`'TCP'`
not_protocol optional	****	The protocol of the listener to exclude.	`TCP`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
protocol	The protocol of the listener.
service_port	The port of the listener.
state	The State of the listener.

1.16 - ListLbServerGroupMembers

1.16.1 - 1.3

scpcli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Get Lb Server Group Member List

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of Member	-
member_ip optional	string	IP of Member	-
member_port optional	integer	Protocol port of Member	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
health_state	Health State of Member
lb_server_group_id	ID of Lb Server Group
member_ip	IP of Member
member_port	Protocol port of Member
member_state	Member State of Member
member_weight	Weight of Member
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of Member
object_id	Object ID of Member
object_type	Object Type of Member
state	State of Member

1.16.2 - 1.2

scpcli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Get Lb Server Group Member 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.

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of Member	-
member_ip optional	string	IP of Member	-
member_port optional	integer	Protocol port of Member	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
health_state	Health State of Member
lb_server_group_id	ID of Lb Server Group
member_ip	IP of Member
member_port	Protocol port of Member
member_state	Member State of Member
member_weight	Weight of Member
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of Member
object_id	Object ID of Member
object_type	Object Type of Member
state	State of Member

1.16.3 - 1.1

scpcli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Get Lb Server Group Member 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.

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of Member	-
member_ip optional	string	IP of Member	-
member_port optional	integer	Protocol port of Member	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
health_state	Health State of Member
lb_server_group_id	ID of Lb Server Group
member_ip	IP of Member
member_port	Protocol port of Member
member_state	Member State of Member
member_weight	Weight of Member
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of Member
object_id	Object ID of Member
object_type	Object Type of Member
state	State of Member

1.17 - ListLBServerGroups

1.17.1 - 1.3

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Get LB Server Group list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	LB Server Group name	`ServerGroup01`
protocol optional	array	Protocol	`'TCP'`
subnet_id optional	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
vpc_id optional	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
lb_method optional	array	LB Method	`'R'`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_name	Load Balancer name	Test-LB-01
lb_server_group_member_count	LB Server Group Member count	2
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.17.2 - 1.2

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Get LB Server Group 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.

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	LB Server Group name	`ServerGroup01`
protocol optional	array	Protocol	`'TCP'`
subnet_id optional	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
vpc_id optional	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
lb_method optional	array	LB Method	`'R'`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_name	Load Balancer name	Test-LB-01
lb_server_group_member_count	LB Server Group Member count	2
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.17.3 - 1.1

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Get LB Server Group 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.

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	LB Server Group name	`ServerGroup01`
protocol optional	array	Protocol	`'TCP'`
subnet_id optional	string	Service Subnet ID	`60fba45cb6c811efba41ba92e4fe7200`
vpc_id optional	string	VPC ID	`8acceeb6920c4fc494490d864f67f0b5`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
lb_method optional	array	LB Method	`'R'`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_name	Load Balancer name	Test-LB-01
lb_server_group_member_count	LB Server Group Member count	2
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.18 - ListLoadbalancerCertificates

1.18.1 - 1.3

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

Name	Description	Example
id	ID of the certificate
cert_kind	Kind of certificate
cn	Common Name of certificate
created_at	Created At
created_by	Created By
modified_at	Modified At
modified_by	Modified By
name	Name of the certificate
not_after_dt	Expiration date and time of the certificate
not_before_dt	Start date and time when the certificate becomes valid
state	State of the certificate

1.18.2 - 1.2

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate 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.

Version	Not Before
1.2	20260319

Responses

Name	Description	Example
id	ID of the certificate
cert_kind	Kind of certificate
cn	Common Name of certificate
created_at	Created At
created_by	Created By
modified_at	Modified At
modified_by	Modified By
name	Name of the certificate
not_after_dt	Expiration date and time of the certificate
not_before_dt	Start date and time when the certificate becomes valid
state	State of the certificate

1.18.3 - 1.1

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate 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.

Version	Not Before
1.1	20260319

Responses

Name	Description	Example
id	ID of the certificate
cert_kind	Kind of certificate
cn	Common Name of certificate
created_at	Created At
created_by	Created By
modified_at	Modified At
modified_by	Modified By
name	Name of the certificate
not_after_dt	Expiration date and time of the certificate
not_before_dt	Start date and time when the certificate becomes valid
state	State of the certificate

1.19 - ListLoadbalancers

1.19.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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	The name of the load balancer.	-
state optional	****	The state of the load balancer.	-
service_ip optional	string	The service IP of the load balancer.	-
subnet_id optional	string	Subnet ID	-
layer_type optional	****	Layer type	-
vpc_id optional	string	VPC ID	-

Responses

Name	Description	Example
id	ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
firewall_id	Firewall ID
layer_type	Layer type
listener_count	The number of listeners.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the load balancer.
public_nat_enabled	Public NAT Enabled Status
service_ip	The service IP of the load balancer.
source_nat_ip	Source NAT IP
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.19.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.

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	The name of the load balancer.	-
state optional	****	The state of the load balancer.	-
service_ip optional	string	The service IP of the load balancer.	-
subnet_id optional	string	Subnet ID	-
layer_type optional	****	Layer type	-
vpc_id optional	string	VPC ID	-

Responses

Name	Description	Example
id	ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
firewall_id	Firewall ID
layer_type	Layer type
listener_count	The number of listeners.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the load balancer.
public_nat_enabled	Public NAT Enabled Status
service_ip	The service IP of the load balancer.
source_nat_ip	Source NAT IP
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.19.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.

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	The name of the load balancer.	-
state optional	****	The state of the load balancer.	-
service_ip optional	string	The service IP of the load balancer.	-
subnet_id optional	string	Subnet ID	-
layer_type optional	****	Layer type	-
vpc_id optional	string	VPC ID	-

Responses

Name	Description	Example
id	ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
firewall_id	Firewall ID
layer_type	Layer type
listener_count	The number of listeners.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the load balancer.
public_nat_enabled	Public NAT Enabled Status
service_ip	The service IP of the load balancer.
source_nat_ip	Source NAT IP
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.20 - RemoveLbServerGroupMember

1.20.1 - 1.3

scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Remove Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-

1.20.2 - 1.2

scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Remove Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-

1.20.3 - 1.1

scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Remove Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-

1.21 - RemoveLbServerGroupMembers

1.21.1 - 1.3

scpcli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>

Description

Remove Lb Server Group Members

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
member_id_list required	array	ID list of Member	-

1.21.2 - 1.2

scpcli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>

Description

Remove Lb Server Group Members

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	ID of Lb Server Group	-
member_id_list required	array	ID list of Member	-

1.22 - SetLBHealthCheck

1.22.1 - 1.3

scpcli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

Set LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`
description optional	string	Description	`this is an lb server group`
health_check_count optional	integer	LB Health Check count	`3`
health_check_interval optional	integer	LB Health Check interval	`5`
health_check_port optional	integer	LB Health Check port	`80`
health_check_timeout optional	integer	LB Health Check timeout	`5`
health_check_url optional	string	LB Health Check URL	`/test`
http_method optional	****	LB Health Check HTTP Method	`GET`
protocol optional	****	LB Health Check Protocol	`TCP`
request_data optional	string	LB Health Check Request data	`username=admin&password=1234`
response_code optional	string	LB Health Check Response code	`200`

1.22.2 - 1.2

scpcli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

Set LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`
description optional	string	Description	`this is an lb server group`
health_check_count optional	integer	LB Health Check count	`3`
health_check_interval optional	integer	LB Health Check interval	`5`
health_check_port optional	integer	LB Health Check port	`80`
health_check_timeout optional	integer	LB Health Check timeout	`5`
health_check_url optional	string	LB Health Check URL	`/test`
http_method optional	****	LB Health Check HTTP Method	`GET`
protocol optional	****	LB Health Check Protocol	`TCP`
request_data optional	string	LB Health Check Request data	`username=admin&password=1234`
response_code optional	string	LB Health Check Response code	`200`

1.22.3 - 1.1

scpcli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

Set LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`
description optional	string	Description	`this is an lb server group`
health_check_count optional	integer	LB Health Check count	`3`
health_check_interval optional	integer	LB Health Check interval	`5`
health_check_port optional	integer	LB Health Check port	`80`
health_check_timeout optional	integer	LB Health Check timeout	`5`
health_check_url optional	string	LB Health Check URL	`/test`
http_method optional	****	LB Health Check HTTP Method	`GET`
protocol optional	****	LB Health Check Protocol	`TCP`
request_data optional	string	LB Health Check Request data	`username=admin&password=1234`
response_code optional	string	LB Health Check Response code	`200`

1.23 - SetLbListener

1.23.1 - 1.3

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--hsts_max_age <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

set loadbalancer listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-
condition_type optional	****	The condition type of the listener.	-
description optional	string	description	-
hsts_max_age optional	integer	The hsts_max_age of the listener.	-
idle_timeout optional	integer	The idle timeout(L7) of the listener.	-
insert_client_ip optional	boolean	Whether the client IP should be inserted.	-
persistence optional	string	The persistence of the listener.	-
response_timeout optional	integer	The response timeout of the listener.	-
server_group_id optional	string	The ID of the server group.	-
session_duration_time optional	integer	The session duration time.	-
sni_certificate optional	array	The sni certificate of the listener.	`'{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}'`
support_http2 optional	boolean	Whether the HTTP 2.0 is supported	-
url_handler optional	array	The URL handler of the listener.	-
url_redirection optional	string	The URL redirect of the listener.	-
x_forwarded_for optional	boolean	Whether the X-Forwarded-For should be inserted.	-
x_forwarded_port optional	boolean	Whether the X-Forwarded-Port should be inserted.	-
x_forwarded_proto optional	boolean	Whether the X-Forwarded-Protocol should be inserted.	-
port optional	string	port	-
protocol optional	string	protocol	-
response_code optional	string	response_code	-
client_cert_id optional	string	Certificate id for client ssl	-
client_cert_level optional	string	Certificate level for client ssl	-
server_cert_level optional	string	Certificate level for server ssl	-

1.23.2 - 1.2

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

set loadbalancer listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-
condition_type optional	****	The condition type of the listener.	-
description optional	string	description	-
insert_client_ip optional	boolean	Whether the client IP should be inserted.	-
persistence optional	string	The persistence of the listener.	-
response_timeout optional	integer	The response timeout of the listener.	-
server_group_id optional	string	The ID of the server group.	-
session_duration_time optional	integer	The session duration time.	-
sni_certificate optional	array	The sni certificate of the listener.	`'{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}'`
support_http2 optional	boolean	Whether the HTTP 2.0 is supported	-
url_handler optional	array	The URL handler of the listener.	-
url_redirection optional	string	The URL redirect of the listener.	-
x_forwarded_for optional	boolean	Whether the X-Forwarded-For should be inserted.	-
x_forwarded_port optional	boolean	Whether the X-Forwarded-Port should be inserted.	-
x_forwarded_proto optional	boolean	Whether the X-Forwarded-Protocol should be inserted.	-
port optional	string	port	-
protocol optional	string	protocol	-
response_code optional	string	response_code	-
client_cert_id optional	string	Certificate id for client ssl	-
client_cert_level optional	string	Certificate level for client ssl	-
server_cert_level optional	string	Certificate level for server ssl	-

1.23.3 - 1.1

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--routing_action <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

set loadbalancer listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-
condition_type optional	****	The condition type of the listener.	-
description optional	string	description	-
insert_client_ip optional	boolean	Whether the client IP should be inserted.	-
persistence optional	string	The persistence of the listener.	-
response_timeout optional	integer	The response timeout of the listener.	-
routing_action optional	****	The routing action of the listener.	-
server_group_id optional	string	The ID of the server group.	-
session_duration_time optional	integer	The session duration time.	-
sni_certificate optional	array	The sni certificate of the listener.	`'{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}'`
support_http2 optional	boolean	Whether the HTTP 2.0 is supported	-
url_handler optional	array	The URL handler of the listener.	-
url_redirection optional	string	The URL redirect of the listener.	-
x_forwarded_for optional	boolean	Whether the X-Forwarded-For should be inserted.	-
x_forwarded_port optional	boolean	Whether the X-Forwarded-Port should be inserted.	-
x_forwarded_proto optional	boolean	Whether the X-Forwarded-Protocol should be inserted.	-
port optional	string	port	-
protocol optional	string	protocol	-
response_code optional	string	response_code	-
client_cert_id optional	string	Certificate id for client ssl	-
client_cert_level optional	string	Certificate level for client ssl	-
server_cert_level optional	string	Certificate level for server ssl	-

1.24 - SetLBServerGroup

1.24.1 - 1.3

scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Set LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`
description optional	string	Description	`this is an lb server group`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
lb_method optional	****	LB Method	`ROUND_ROBIN`

1.24.2 - 1.2

scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Set LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`
description optional	string	Description	`this is an lb server group`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
lb_method optional	****	LB Method	`ROUND_ROBIN`

1.24.3 - 1.1

scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Set LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`
description optional	string	Description	`this is an lb server group`
lb_health_check_id optional	string	LB Health Check ID	`46c681018e33453085ca7c8db54e0076`
lb_method optional	****	LB Method	`ROUND_ROBIN`

1.25 - SetLbServerGroupMember

1.25.1 - 1.3

scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Set Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-
member_port optional	integer	Protocol port of Member	`80`
member_state optional	****	Member State of Member	-
member_weight optional	integer	Weight of Member	`100`

1.25.2 - 1.2

scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Set Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-
member_port optional	integer	Protocol port of Member	`80`
member_state optional	****	Member State of Member	-
member_weight optional	integer	Weight of Member	`100`

1.25.3 - 1.1

scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Set Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-
member_port optional	integer	Protocol port of Member	`80`
member_state optional	****	Member State of Member	-
member_weight optional	integer	Weight of Member	`100`

1.26 - SetLoadbalancer

1.26.1 - 1.3

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
description required	string	description	-

1.26.2 - 1.2

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
description required	string	description	-

1.26.3 - 1.1

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-
description required	string	description	-

1.27 - ShowLBHealthCheck

1.27.1 - 1.3

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
health_check_count	LB Health Check count	3
health_check_interval	LB Health Check interval	5
health_check_port	LB Health Check port	80
health_check_timeout	LB Health Check timeout	5
health_check_type	LB Health Check type	DEFAULT
health_check_url	LB Health Check URL	/test
http_method	LB Health Check HTTP Method	GET
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
request_data	LB Health Check Request data	username=admin&password=1234
response_code	LB Health Check Response code	200
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.27.2 - 1.2

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
health_check_count	LB Health Check count	3
health_check_interval	LB Health Check interval	5
health_check_port	LB Health Check port	80
health_check_timeout	LB Health Check timeout	5
health_check_type	LB Health Check type	DEFAULT
health_check_url	LB Health Check URL	/test
http_method	LB Health Check HTTP Method	GET
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
request_data	LB Health Check Request data	username=admin&password=1234
response_code	LB Health Check Response code	200
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.27.3 - 1.1

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_health_check_id required	string	LB Health Check ID	`e3cd678b11784734bc366148aa37580e`

Responses

Name	Description	Example
id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
health_check_count	LB Health Check count	3
health_check_interval	LB Health Check interval	5
health_check_port	LB Health Check port	80
health_check_timeout	LB Health Check timeout	5
health_check_type	LB Health Check type	DEFAULT
health_check_url	LB Health Check URL	/test
http_method	LB Health Check HTTP Method	GET
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Health Check name	Test-LbMonitor-01
protocol	LB Health Check Protocol	TCP
request_data	LB Health Check Request data	username=admin&password=1234
response_code	LB Health Check Response code	200
state	LB Health Check state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.28 - ShowLbListener

1.28.1 - 1.3

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_type	The condition type of the listener.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
hsts_max_age	The hsts_max_age of the listener.
https_redirection	The https redirection of the listener.
idle_timeout	The idle timeout(L7) of the listener.
insert_client_ip	Whether the client IP should be inserted.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
persistence	The persistence of the listener.
protocol	The protocol of the listener.
response_timeout	The response timeout of the listener.
routing_action	The routing action of the listener.
server_group_id	The ID of the server group.
server_group_name	The Name of the server group.
service_port	The port of the listener.
session_duration_time	The session duration time.
sni_certificate	The sni certificate of the listener.
ssl_certificate	The ssl certificate of the listener.
state	The State of the listener.
support_http2	Whether the HTTP 2.0 is supported
url_handler	The URL handler of the listener.
url_redirection	The URL redirect of the listener.
x_forwarded_for	Whether the X-Forwarded-For should be inserted.
x_forwarded_port	Whether the X-Forwarded-Port should be inserted.
x_forwarded_proto	Whether the X-Forwarded-Protocol should be inserted.

1.28.2 - 1.2

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_type	The condition type of the listener.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
https_redirection	The https redirection of the listener.
insert_client_ip	Whether the client IP should be inserted.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
persistence	The persistence of the listener.
protocol	The protocol of the listener.
response_timeout	The response timeout of the listener.
routing_action	The routing action of the listener.
server_group_id	The ID of the server group.
server_group_name	The Name of the server group.
service_port	The port of the listener.
session_duration_time	The session duration time.
sni_certificate	The sni certificate of the listener.
ssl_certificate	The ssl certificate of the listener.
state	The State of the listener.
support_http2	Whether the HTTP 2.0 is supported
url_handler	The URL handler of the listener.
url_redirection	The URL redirect of the listener.
x_forwarded_for	Whether the X-Forwarded-For should be inserted.
x_forwarded_port	Whether the X-Forwarded-Port should be inserted.
x_forwarded_proto	Whether the X-Forwarded-Protocol should be inserted.

1.28.3 - 1.1

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
listener_id required	string	The ID of the listener.	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_type	The condition type of the listener.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
https_redirection	The https redirection of the listener.
insert_client_ip	Whether the client IP should be inserted.
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	The name of the listener.
persistence	The persistence of the listener.
protocol	The protocol of the listener.
response_timeout	The response timeout of the listener.
routing_action	The routing action of the listener.
server_group_id	The ID of the server group.
server_group_name	The Name of the server group.
service_port	The port of the listener.
session_duration_time	The session duration time.
sni_certificate	The sni certificate of the listener.
ssl_certificate	The ssl certificate of the listener.
state	The State of the listener.
support_http2	Whether the HTTP 2.0 is supported
url_handler	The URL handler of the listener.
url_redirection	The URL redirect of the listener.
x_forwarded_for	Whether the X-Forwarded-For should be inserted.
x_forwarded_port	Whether the X-Forwarded-Port should be inserted.
x_forwarded_proto	Whether the X-Forwarded-Protocol should be inserted.

1.29 - ShowLBServerGroup

1.29.1 - 1.3

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_method	LB Method	ROUND_ROBIN
lb_name	Load Balancer name	Test-LB-01
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.29.2 - 1.2

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_method	LB Method	ROUND_ROBIN
lb_name	Load Balancer name	Test-LB-01
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.29.3 - 1.1

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_server_group_id required	string	LB Server Group ID	`3d8d8754d0d54683a29f3dcc3dd95d5b`

Responses

Name	Description	Example
id	LB Server Group ID	3d8d8754d0d54683a29f3dcc3dd95d5b
account_id	Account ID	e3cd678b11784734bc366148aa37580e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	this is an lb server group
lb_health_check_id	LB Health Check ID	46c681018e33453085ca7c8db54e0076
lb_method	LB Method	ROUND_ROBIN
lb_name	Load Balancer name	Test-LB-01
loadbalancer_id	Load Balancer ID	82efa35c88834bc083020443e57faa10
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	LB Server Group name	ServerGroup01
protocol	Protocol	TCP
state	LB Server Group state	ACTIVE
subnet_id	Service Subnet ID	60fba45cb6c811efba41ba92e4fe7200
vpc_id	VPC ID	8acceeb6920c4fc494490d864f67f0b5

1.30 - ShowLbServerGroupMember

1.30.1 - 1.3

scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Show Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-

Responses

Name	Description	Example
member

1.30.2 - 1.2

scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Show Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-

Responses

Name	Description	Example
member

1.30.3 - 1.1

scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Show Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
member_id required	string	ID of Member	-
lb_server_group_id required	string	ID of Lb Server Group	-

Responses

Name	Description	Example
member

1.31 - ShowLoadbalancer

1.31.1 - 1.3

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
id	ID
account_id	The account ID of the load balancer.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
firewall_id	Firewall ID
health_check_ip	Health check IP
layer_type	Layer type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
public_nat_enabled	Public NAT Enabled Status
service_ip	The service IP of the load balancer.
source_nat_ip	Source NAT IP
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.31.2 - 1.2

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
id	ID
account_id	The account ID of the load balancer.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
firewall_id	Firewall ID
health_check_ip	Health check IP
layer_type	Layer type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
public_nat_enabled	Public NAT Enabled Status
service_ip	The service IP of the load balancer.
source_nat_ip	Source NAT IP
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.31.3 - 1.1

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
id	ID
account_id	The account ID of the load balancer.
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	description
firewall_id	Firewall ID
health_check_ip	Health check IP
layer_type	Layer type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	name
public_nat_enabled	Public NAT Enabled Status
service_ip	The service IP of the load balancer.
source_nat_ip	Source NAT IP
state	The state of the load balancer.
subnet_id	Subnet ID
vpc_id	VPC ID

1.32 - ShowLoadbalancerCertificate

1.32.1 - 1.3

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
lb_certificate_id required	string	The ID of the certificate	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	The project ID of the certificate
cert_body	The body of the certificate
cert_chain	The chain of the certificate
cert_kind
cn
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organization	The organization of the certificate
private_key	The private key of the certificate
state

1.32.2 - 1.2

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
lb_certificate_id required	string	The ID of the certificate	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	The project ID of the certificate
cert_body	The body of the certificate
cert_chain	The chain of the certificate
cert_kind
cn
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organization	The organization of the certificate
private_key	The private key of the certificate
state

1.32.3 - 1.1

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
lb_certificate_id required	string	The ID of the certificate	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	The project ID of the certificate
cert_body	The body of the certificate
cert_chain	The chain of the certificate
cert_kind
cn
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organization	The organization of the certificate
private_key	The private key of the certificate
state

1.33 - ShowLoadbalancerPrivateNatIp

1.33.1 - 1.3

scpcli loadbalancer loadbalancer-private-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
static_nat

1.34 - ShowLoadbalancerPublicNatIp

1.34.1 - 1.3

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
external_ip_address	Static Nat External Ip Address
publicip_id	Publicip ID
state	Static Nat State

1.34.2 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
external_ip_address	Static Nat External Ip Address
publicip_id	Publicip ID
state	Static Nat State

1.34.3 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Name	Type	Description	Example
loadbalancer_id required	string	ID	-

Responses

Name	Description	Example
external_ip_address	Static Nat External Ip Address
publicip_id	Publicip ID
state	Static Nat State