DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

Load Balancing

CreateLoadBalancer

Creates a load balancer. For example,
CreateLoadBalancer name=LB1 vipUuid=dc0ee73ed875423aa6778fc091e3ce70

Parameters

Name Description Optional Valid Value Starting Version
name The load balancer name. 0.6
description The detailed description of the load balancer. Yes 0.6
vipUuid The VIP UUID. 0.6
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerVO. Yes 0.6
timeout Yes

UpdateLoadBalancer

Updates a load balancer. For example,
UpdateLoadBalancer uuid=901ddf386552467298685d08949911f8

Parameters

Name Description Optional Valid Value Starting Value
uuid The resource UUID. 0.6
name The load balancer name. Yes 0.6
description The detailed description of the load balancer. Yes 0.6
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerVO. Yes 0.6
timeout Yes

DeleteLoadBalancer

Deletes a load balancer. For example,
DeleteLoadBalancer uuid=18fa017f308342f5a580edcbb63dbeb3

Parameters

Name Description Optional Valid Value Starting Version
uuid The load balancer UUID. 0.6
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive
  • Enforcing
 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerVO. Yes 0.6
timeout Yes

QueryLoadBalancer

Queries a load balancer. For example,
QueryLoadBalancer vipUuid=dc0ee73ed875423aa6778fc091e3ce70
QueryLoadBalancer listeners.uuid=ba50b5cd2e09461e9aea80df779c425d

Primitive Fields of Query

See Load Balancer Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
loadBalancer Load Balancer Inventory 0.6
vmNic VM NIC Inventory 0.6
vmNicRefs VM NIC References Inventory 0.6

RefreshLoadBalancer

Refreshes a load balancer. For example,
RefreshLoadBalancer uuid=bad56001c1f24cefa085fa9cf83f6424

Parameters

Name Description Optional Valid Value Starting Version
uuid The load balancer UUID. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerVO. Yes 0.6
timeout Yes

CreateLoadBalancerListener

Creates a load balancer listener. For example,
CreateLoadBalancerListener name=lblistener loadBalancerUuid=bad56001c1f24cefa085fa9cf83f6424\
loadBalancerPort=22 instancePort=23

Parameters

Name Description Optional Valid Value Starting Version
loadBalancerUuid The UUID of the load balancer listener. 0.6
certificateUuid 2.3
name The name of the load balancer listener. 0.6
description The detailed description of the load balancer listener. Yes 0.6
instancePort The VM instance port. Yes 0.6
loadBalancerPort The load balancer port. 0.6
protocol The protocol. Yes
  • tcp
  • http
  • https
  • udp
 0.6
resourceUuid The resource UUID. Yes 0.6
instancePort Yes 3.9.0
healthCheckProtocol The health check protocol. Yes
  • tcp
  • udp
  • http
 3.9.0
healthCheckMethod The health check method. Yes
  • GET
  • HEAD
 3.9.0
healthCheckURI The health check URI. Yes 3.9.0
healthCheckHttpCode The expected response code of the health code. Yes 3.9.0
aclStatus The access control status. Yes
  • enable
  • disable
 3.9.0
aclUuids The access control list. Yes 3.9.0
aclType The access control type. Yes
  • white
  • black
 3.9.0
tagUuids The tag UUID list. Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type LoadBalancerListenerVO. Yes 0.6
timeout Yes
Note:
  • When you create a load balancer listener in ZStack Cloud, you can set seven layers of health check parameters by adding the healthCheckParameter option to SystemTags.
    • Format of the healthCheckParameter option: healthCheckParameter::{parameter}. Here, the parameter can be healthCheckParameter::method:uri:expect-result.
    • Example: healthCheckParameter::GET:/healthstatus.html:http_2xx
  • When you create a load balancer listener in ZStack Cloud, you can set the access control status of the listener by adding the accessControlStatus option to SystemTags.
    • Format of the accessControlStatus option: accessControlStatus::{status}
    • Example: accessControlStatus::enable
  • When you create a load balancer listener in ZStack Cloud, you can set whether to enable the session persistence and specify the session persistence mode by adding the sessionPersistence option to SystemTags.
    • Format of the sessionPersistenceoption: sessionPersistence::{%s}.. The value of %s can be disable/iphash/insert/rewrite.
    • Example: sessionPersistence::insert.
  • When you create a load balancer listener in ZStack Cloud, you can specify the session persistence time by adding the sessionIdleTimeout option to SystemTags.
    • Format of the sessionIdleTimeoutoption: sessionIdleTimeout::{%s}. Here, %s is the session persistence time. Valid value: 30-3600. Unit:second.
    • Example: sessionIdleTimeout::60
  • When you create a load balancer listener in ZStack Cloud, you can set the rewritten cookie name by adding the cookieName option to SystemTags.
    • Format of the validRegexValues::{%s}. Here, %s is the cookie name. The name must be 1 to 20 characters and can contain uppercase or lowercase letters, digits, hyphens (-), and underscores (_).
    • Example: cookieName::zstack-cookie.
  • When you create a load balancer listener in ZStack Cloud, you can set whether to enable http redirect by adding the httpRedirectHttps option to SystemTags.
    • Format of the httpRedirectHttps::{%s}. Here, the value of %s can be disable/enable.
    • Example: httpRedirectHttps::enable
  • When you create a load balancer listener in ZStack Cloud, you can set redirect port by adding redirectPort option to SystemTags.
    • Format of the redirectPort::{%s}. Here, the number range of %s can be 1-65535.
    • Example: redirectPort::80
  • When you create a load balancer listener in ZStack Cloud, you can set redirect status code by adding statusCode optional to SystemTags.
    • Format of the statusCode::{%s}. Here, the value of %s can be 301/302/303/307/308.
    • Example: statusCode::302

DeleteLoadBalancerListener

Deletes a load balancer listener. For example,
DeleteLoadBalancerListener uuid=03b7ad0224774dbab3dcdc4dbce74df4

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the load balancer listener. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

QueryLoadBalancerListener

Queries a load balancer listener. For example,
QueryLoadBalancerListener uuid=7e331a2f61ed4c65b96d521115bc9f16
QueryLoadBalancerListener loadBalancer.uuid=bad56001c1f24cefa085fa9cf83f6424

Primitive Fields of Query

See Load Balancer Listener Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
loadBalancer Load Balancer Inventory 0.6
vmNic VM NIC Inventory 0.6
vmNicRefs VM NIC References Inventory 0.6

UpdateLoadBalancerListener

Updates a load balancer listener. For example,
UpdateLoadBalancerListener  uuid=897b8f83e7b44fc785023ae8b8338edd

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 0.6
name The resource name. Yes 0.6
description The detailed description of the resource. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout

ChangeLoadBalancerListener

Changes a parameter of a load balancer listener. For example,
ChangeLoadBalancerListener uuid=dc0ee73ed875423a81234fc091e3ce70

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.4.0
connectionIdleTimeout The connection timeout. Yes 4.6.0
maxConnection The maximum number of concurrent connections. Yes 4.6.0
balancerAlgorithm The load balancing algorithm. Yes
  • weightroundrobin
  • roundrobin
  • leastconn
  • source
 4.6.0
healthCheckTarget The health check port. Yes 4.6.0
healthyThreshold The threshold of the healthy state. Yes 4.6.0
unhealthyThreshold The threshold of the unhealthy state. Yes 4.6.0
healthCheckInterval The health check interval. Yes 4.6.0
healthCheckProtocol The health check protocol. Yes
  • tcp
  • udp
  • http
 3.9.0
healthCheckMethod The health check method. Yes
  • GET
  • HEAD
 3.9.0
healthCheckURI The health check URI. Yes 3.9.0
healthCheckHttpCode The expected response code of the health code. Yes 3.9.0
aclStatus The access control status. Yes
  • enable
  • disable
 3.9.0
securityPolicyType The transport layer security policy. Yes
  • tls_cipher_policy_default
  • tls_cipher_policy_1_0
  • tls_cipher_policy_1_1
  • tls_cipher_policy_1_2
  • tls_cipher_policy_1_2_strict
  • tls_cipher_policy_1_2_strict_with_1_3
 4.1.0
nbprocess The number of SLB processes. Yes 4.1.0
httpMode The HTTP Mode of SLB. Yes
  • http-keep-alive
  • http-server-close
  • http-tunnel
  • httpclose
  • forceclose
 4.1.0
sessionPersistence The session persistence mode. Yes
  • disable
  • iphash
  • insert
  • rewrite
 4.6.0
sessionIdleTimeout The session persistence time. Yes 4.6.0
cookieName The Cookie name. Yes 4.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.6.0
timeout Yes
httpRedirectHttps The http redirects https. Yes
  • disable
  • enable
 4.7.21
redirectPort The redirect port. Yes 4.7.21
statusCode The redirect status code. Yes
  • 301
  • 302
  • 303
  • 307
  • 308
 4.7.21
Note:
  • When you change a parameter of a load balancer listener in ZStack Cloud, you can set the weight of the backend server by adding the balancerWeight option to SystemTags.
    • Format of the balancerWeight option: balancerWeight::{nicUuid}::{weight} . Here, weight is the weight of the backend server. Weight range: 0-100, integer. Default value: 100.
    • Example: balancerWeight::{"c44007641c9040c6b2587e19b1b3e2b0"}::{100}

GetCandidateVmNicsForLoadBalancer

Obtains a VM NIC for a load balancer. For example,
GetCandidateVmNicsForLoadBalancer listenerUuid=7e331a2f61ed4c65b96d521115bc9f16

Parameters

Name Description Optional Valid Value Starting Version
listenerUuid The UUID of the load balancer listener. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system types. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

AddVmNicToLoadBalancer

Adds a VM NIC to a load balancer. For example,
AddVmNicToLoadBalancer listenerUuid=7e331a2f61ed4c65b96d521115bc9f16 \
vmNicUuids=93dea4f116654754ac4d40e50b3c8cad

Parameters

Name Description Optional Valid Value Starting Version
vmNicUuids The VM NIC UUID. 0.6
listenerUuid The UUID of the load balancer listener. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes
Note:
  • When you add a VM NIC to a load balancer in ZStack Cloud, you can set the weight of the backend server by adding the balancerWeight option to SystemTags.
    • Format of the balancerWeight option: balancerWeight::{nicUuid}::{weight}. Here, weight is the weight of the backend server. Weight range: 0-100, integer. Default value: 100.
    • Example: balancerWeight::{"c44007641c9040c6b2587e19b1b3e2b0"}::{100}

RemoveVmNicFromLoadBalancer

Removes a VM NIC from a load balancer. For example.
RemoveVmNicFromLoadBalancer listenerUuid=7e331a2f61ed4c65b96d521115bc9f16 \
vmNicUuids=93dea4f116654754ac4d40e50b3c8cad

Parameters

Name Description Optional Valid Value Starting Version
vmNicUuids The VM NIC UUID. 0.6
listenerUuid The UUID of the load balancer listener. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

CreateCertificate

Creates a certificate. For example, 
CreateCertificate name=www.domain.com certificate=MIIDlzCCAn+gAwIBAgIJAPdiQszRKI/MMA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNVBAYTAkNOMQ8wDQYDVQQIDAZaU1RBQ0sxCzAJBgNVBAcMAlNIMQ0wCwYDVQQKDARaU1kIMQwwCgYDVQQLDANkZXYxGDAWBgNVBAMMD2Rldi56c3Rhawhjay5pbzAeFw0xODAzMjkxMjQ5NDVaFw0xOTAzMjkxMjQ5NDVaMGIxCzAJBgNVBAYTAkNOMQ8wDQYDVQQIDAZaU1RBQ0sxCzAJBgNVBAcMAlNIMQ0wCwYDVQQKDARaU1kIMQwwCgYDVQQLDANkZXYxGDAWBgNVBAMMD2Rldi56c3Rhawhjay5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANc3Q15Wq9IHJyUtMuB+G17WLp3AoVoJTEHbD2xO2RQ0sp+eaOVD3Kj8TkPw+t4ZXIllcMbsJk4+DQP1ix3gnGvlAqThxS6mA3RsUQooHwvYBI8ETePJmurDmz7HEll6XTGHxj7Hp57BnLGQgoJmGqfA8zmtK1Le/zJK6xjpl6GYpfov2h5dU+h9qzv9IBNViUIeW3yn6VY47smtaPCQ5pJT35A7GyqFoTbAlpXca+XS2LTUnNZBgXEmG/d8JBdvvJDSZSQVtVslK0Wx2IsroqkMgyX1EFxjZrIlnQsGb1bEYURgM4oF2deveFjpCUZgI6MOOA6ZuVh1rJxk9XxoZ+0CAwEAAaNQME4wHQYDVR0OBBYEFCLaAR9gaKBopzVqzBu3pUrKm027MB8GA1UdIwQYMBaAFCLaAR9gaKBopzVqzBu3pUrKm027MAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAAuGNv9qZud6UEDfypuHUkGHzECKltEv+S/CgZPXcs1W8zumQjXE7IpFffrAsM9wf51R8dBLaIdnAn6YMuANdrH5L/lALzhrfOwuT6hvEDWznrN7Ea7XANICBactyEpXFxg6eTuFNgWb41IXFJmD225jN82OcFVSQO5/zFfqvnAB6Rz47HV4qKJxs0ZuuAvnbAUf0++pqhxFfjD0TeLPGCB5gNdipprPRJCBiTMFKUN+IJPjjRWcSy1FH8rAZhzNUYtDtwFX4dVoS+CKPaIEurUMCxPzFlgy3VLQU99Mhnn3lxDt9N4OOFCVpLyohfkXLmU5mJGPbs/HT3gl2k+mjt8\u003d

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 0.6
description The detailed description of the resource. Yes 0.6
certificate The certificate. 2.3
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

UpdateCertificate

Updates the information about a certificate. For example,
UpdateCertificate uuid=98c7a9b92e9c4015a66dd930f82337b8

Parameters

Name Description Optional Valid Value Starting Version
uuid 0.6
name The resource name. Yes 0.6
description The detailed description of the resource. Yes 0.6
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

DeleteCertificate

Deletes a certificate. For example,
DeleteCertificate uuid=b7f97d1fb45f4c8785e1b607f671651b

Parameters

Name Description Optional Valid Value Starting Version
uuid 0.6
deleteMode Yes 0.6
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

QueryCertificate

Queries a certificate. For example,
QueryCertificate uuid=98c7a9b92e9c4015a66dd930f82337b8

Parameters

Name Description Optional Valid Value Starting Version
uuid Yes 0.6
name The resource name. Yes 0.6
createDate The creation date. Yes 0.6
lastOpDate The last operation date. Yes 0.6
groupBy Yes 0.6
description The detailed description of the resource. Yes 0.6
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

AddCertificateToLoadBalancerListener

Adds a certificate to a load balancer listener. For example,
AddCertificateToLoadBalancerListener listenerUuid=a0c2wva8b45f4c8785e1b607f6716013 certificateUuid=b7f97d1fb45f4c8785e1b607f671651b

Parameters

Name Description Optional Valid Value Starting Version
certificateUuid 2.3
listenerUuid 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

RemoveCertificateFromLoadBalancerListener

Removes a certificate from a load balancer listener. For example,
RemoveCertificateFromLoadBalancerListener listenerUuid=a0c2wva8b45f4c8785e1b607f6716013 certificateUuid=98c7a9b92e9c4015a66dd930f82337b8

Parameters

Name Description Optional Valid Value Starting Version
certificateUuid 2.3
listenerUuid 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is LoadBalancerListenerVO. Yes 0.6
timeout Yes

AddAccessControlListRedirectRule

Adds a forwarding rule to an access control list. For example,
AddAccessControlListRedirectRule aclUuid=bad56001c1f24cefa085fa9cf83f6424

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. Yes 4.1.0
description The detailed description of the resource. Yes 4.1.0
domain The domain name. Yes 4.1.0
url The URL. Yes 4.1.0
aclUuid The UUID of the access control list. 4.1.0
resourceUuid The resource UUID. Yes 4.1.0
tagUuids The tag UUID list. Yes 4.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.1.0
timeout Yes

ChangeAccessControlListRedirectRule

Changes the name of a forwarding rule in an access control list. For example,
ChangeAccessControlListRedirectRule uuid=bad56001c1fac4512a9cf83f6424

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.1.0
name The name of the forwarding rule. Yes 4.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.1.0
timeout Yes

ChangeAccessControlListServerGroup

Changes the backend server group associated by an access control list. For example,
ChangeAccessControlListServerGroup serverGroupUuids=bad56001c1fac4512a9cf83f6424 listenerUuid=89bdb613cad93f5f881b9127986d4d1b aclUuid=e58cd2cd6a633f999909c7e5ce448e07

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuids The UUID of the backend server group. 4.1.0
listenerUuid The UUID of the listener. 4.1.0
aclUuid The UUID of the access control list. 4.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.1.0
timeout Yes

GetLoadBalancerListenerACLEntries

Obtains the access control list entries of a load balancer listener. For example,
GetLoadBalancerListenerACLEntries listenerUuids=e58cd2cd6a633f999909c7e5ce448e07

Parameters

Name Description Optional Valid Value Starting Version
listenerUuids Yes 4.1.0
type Yes 4.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.1.0
timeout Yes

CreateAccessControlList

Creates an access control list. For example,
CreateAccessControlList name=acl-group ipVersion=4

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 3.9.0
description The detailed description of the resource. Yes 3.9.0
ipVersion The IP version. Yes
  • 4
  • 6
 3.9.0
resourceUuid The resource UUID. Yes 3.9.0
tagUuids The tag UUID list. Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

DeleteAccessControlList

Deletes an access control list. For example,
DeleteAccessControlList uuid=f2a128d702d83f4389ad82d425b0e74e deleteMode=Permissive

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.9.0
deleteMode The delete mode. Options: Permissive | Enforcing. Default mode: Permissive. Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

QueryAccessControlList

Queries an access control list. For example,
QueryAccessControlList uuid=0abdbd20b8173ccf89f881309b5e40d0

Primitive Fields of Query

See Access Control List Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
loadBalancerListener Load Balancer Listener Inventory The load balancer listeners related to the access control list. 3.9.0

RemoveAccessControlListEntry

Removes IP entries from an access control list. For example,
RemoveAccessControlListEntry aclUuid=c151f0f90e143c26b6667e70ebbe5b7b uuid=22c9d1f964b63f6abc52fed8437042a3

Parameters

Name Description Optional Valid Value Starting Version
aclUuid The UUID of the access control list. 3.9.0
uuid The resource UUID. 3.9.0
deleteMode The delete mode. Options: Permissive | Enforcing. Default mode: Permissive. Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

AddAccessControlListEntry

Adds IP entries to an access control list. For example,
AddAccessControlListEntry aclUuid=101a39fcb6c538a4914d0ae7fa8468a4 entries=192.168.12.1,192.168.48.0/24

Parameters

Name Description Optional Valid Value Starting Version
aclUuid The UUID of the access control list. 3.9.0
entries The IP entries. 3.9.0
description The detailed description of the resource. Yes 3.9.0
resourceUuid The resource UUID. Yes 3.9.0
tagUuids The tag UUID list. Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

AddAccessControlListToLoadBalancer

Adds an access control list to a listener. For example,
AddAccessControlListToLoadBalancer aclUuids=25e10ecdb6d63b598899c1103d2cdf46 aclType=white listenerUuid=19c1a4dcaea637da86e3ecbb6a3a5f6e

Parameters

Name Description Optional Valid Value Starting Version
aclUuids The UUID of the access control list. 3.9.0
aclType The access control type.
  • white
  • black
  • redirect
 4.1.0
listenerUuid The listener UUID. 3.9.0
serverGroupUuids The UUID of the load balancer server group. Yes 4.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

RemoveAccessControlListFromLoadBalancer

Removes an access control list from a listener. For example,
RemoveAccessControlListFromLoadBalancer aclUuids=027bfcc0fddf39e3be51badf4777c0cd listenerUuid=0299b3e26af5350c8db91930723d2065

Parameters

Name Description Optional Valid Value Starting Version
aclUuids The UUID of the access control list. 3.9.0
listenerUuid The listener UUID. 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

GetCandidateL3NetworksForLoadBalancer

Obtains the L3 networks that can be attached to a listener. For example,
GetCandidateL3NetworksForLoadBalancer listenerUuid=6ecc19bdec0139499e3abf6c51bca683

Parameters

Name Description Optional Valid Value Starting Version
listenerUuid 3.9.0
limit Yes 3.9.0
start Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

CreateLoadBalancerServerGroup

Create a server group for load balancing. For example,
CreateLoadBalancerServerGroup name=BackendServerGroup loadBalancerUuid=70320d7aaedf4241a426560d09d99863

Parameters

Name Description Optional Valid Value Starting Version
name The name of the server group for load balancing. 4.0.0
description The detailed description of the server group. Yes 4.0.0
loadBalancerUuid The load balancer UUID. 4.0.0
resourceUuid The UUID of the server group. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

DeleteLoadBalancerServerGroup

Deletes a server group for load balancing. For example,
DeleteLoadBalancerServerGroup uuid=70320d7aaedf4241a426560d09d99863

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the server group. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

UpdateLoadBalancerServerGroup

Updates a load balancer server group. For example,
UpdateLoadBalancerServerGroup uuid=bad56001c1f24cefa085fa9cf83f6424

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.0.0
name The resource name. Yes 4.0.0
description The detailed description of the resource. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

QueryLoadBalancerServerGroup

Queries server groups for load balancing. For example,
QueryLoadBalancerServerGroup uuid=70320d7aaedf4241a426560d09d99863

Primitive Fields of Query

See LoadBalancerServerGroup Inventory.

Nested And Expanded Fields of Query

Field Inventory Description Starting Version
listenerServerGroupRefs Listener Server Group Refs Inventory. The listener of the server group. 4.0.0

AddBackendServerToServerGroup

Adds a server to a server group. For example,
AddBackendServerToServerGroup serverGroupUuid=70320d7aaedf4241a426560d09d99863

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuid The UUID of the server group for load balancing. 4.0.0
vmNics The NIC of the backend server. Yes 4.0.0
servers The IP address of the backend server. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

RemoveBackendServerFromServerGroup

Removes servers from a server group for load balancing. For example,
RemoveBackendServerFromServerGroup serverGroupUuid=70320d7aaedf4241a426560d09d99863

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuid The server group UUID. 4.0.0
vmNicUuids Yes 4.0.0
serverIps Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

AddServerGroupToLoadBalancerListener

Associates a server group for load balancing with a listener. For example,
AddServerGroupToLoadBalancerListener serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16 listenerUuid=93dea4f116654754ac4d40e50b3c8cad

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuid The UUID of the server group for load balancing. 4.0.0
listenerUuid The UUID of the listener. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

RemoveServerGroupFromLoadBalancerListener

Disassociates a server group from a listener. For example,
RemoveServerGroupFromLoadBalancerListener serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16 listenerUuid=93dea4f116654754ac4d40e50b3c8cad

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuid The server group UUID. 4.0.0
listenerUuid The listener UUID. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

ChangeLoadBalancerBackendServer

Changes backend servers in a server group for load balancing. For example,
ChangeLoadBalancerBackendServer serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuid The UUID of the server group for load balancing. 4.0.0
vmNics The VM NICs. Yes 4.0.0
servers The IP addresses of backend servers. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

GetCandidateVmNicsForLoadBalancerServerGroup

Retrieves available NICs that can be added to a server group. For example,
GetCandidateVmNicsForLoadBalancerServerGroup serverGroupUuid=7e331a2f61ed4c65b96d521115bc9f16

Parameters

Name Description Optional Valid Value Starting Version
serverGroupUuid The UUID of the server group. Yes 4.0.0
loadBalancerUuid The load balancer UUID. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

CreateSlbGroup

Creates an SLB group. For example,
CreateSlbGroup name=SLBGroup slbOfferingUuid=bad56001c1f24cefa085fa9cf83f6424 frontEndL3NetworkUuid=dc0ee73ed875423aa6778fc091e3ce70

Parameters

Name Description Optional Valid Value Starting Version
name The name of the SLB group. 4.0.0
slbOfferingUuid The UUID of the SLB offering. 4.0.0
frontEndL3NetworkUuid The frontend L3 network UUID. 4.0.0
backendL3NetworkUuids The backend L3 network UUID. Yes 4.0.0
backendType The backend type. Yes
  • VYOS
 4.0.0
deployType The deployment type. Yes
  • Direct
 4.0.0
description The detailed description of the SLB group. Yes 4.0.0
resourceUuid The UUID of the SLB group. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

DeleteSlbGroup

Deletes an SLB group. For example,
DeleteSlbGroup uuid=70320d7aaedf4241a426560d09d99863

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the SLB group. 4.0.0
deleteMode The deletion mode. Yes
  • Permissive
  • Enforcing
 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

UpdateSlbGroup

Updates an SLB group. For example,
UpdateSlbGroup uuid=897b8f83e7b44fc785023ae8b8338edd

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the SLB group. 4.0.0
name The name of the SLB group. Yes 4.0.0
description The detailed description of the SLB group. Yes 4.0.0
slbOfferingUuid The UUID of the SLB offering. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout

QuerySlbGroup

Queries SLB groups. For example,
QuerySlbGroup uuid=7e331a2f61ed4c65b96d521115bc9f16

Primitive Fields of Query

See SlbGroup inventory.

CreateSlbOffering

Creates an SLB offering. For example,
CreateSlbOffering name=SLBOffering zoneUuid=bad56001c1f24cefa085fa9cf83f6424 managementNetworkUuid=dc0ee73ed875423aa6778fc091e3ce70 imageUuid=2aa6ae40c4954143be0ecb9a6a160b5b cpuNum=1 memorySize=1073741824

Parameters

Name Description Optional Valid Value Starting Version
zoneUuid The zone UUID. 4.0.0
managementNetworkUuid The management network UUID. 4.0.0
imageUuid The image UUID. 4.0.0
name The name of the SLB offering. 4.0.0
description The detailed description of the SLB offering. Yes 4.0.0
cpuNum 4.0.0
memorySize 4.0.0
allocatorStrategy Yes 4.0.0
sortKey Yes 4.0.0
type Yes 4.0.0
resourceUuid The UUID of the SLB offering. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes

QuerySlbOffering

Queries SLB offerings. For example,
QuerySlbOffering uuid=7e331a2f61ed4c65b96d521115bc9f16

Primitive Fields of Query

See SlbOffering inventory.

Nested And Expanded Fields of Query

Field Inventory Description Starting Version
image image inventory 4.0.0
managementL3Network L3 network inventory 4.0.0
publicL3Network L3 network inventory 4.0.0
vmInstance VM instance inventory 4.0.0
zone zone inventory 4.0.0

CreateSlbInstance

Create an SLB instance. For example,
CreateSlbInstance name=SLBinstance slbGroupUuid=bad56001c1f24cefa085fa9cf83f6424

Parameters

Name Description Optional Valid Value Starting Version
name The name of the SLB group. 4.0.0
slbGroupUuid The UUID of the SLB group. 4.0.0
description The detailed description of the SLB group. Yes 4.0.0
zoneUuid The zone UUID Yes 4.0.0
clusterUuid The cluster UUID. Yes 4.0.0
hostUuid The host UUID. Yes 4.0.0
resourceUuid The instance UUID. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes
PreviousPort ForwardingNextIPsec
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center