Apache CloudStack v4.4.0 Domain Admin API Reference

createLoadBalancerRule

Creates a load balancer rule

Request parameters

Parameter NameDescriptionRequired
algorithmload balancer algorithm (source, roundrobin, leastconn)true
namename of the load balancer ruletrue
privateportthe private port of the private ip address/virtual machine where the network traffic will be load balanced totrue
publicportthe public port from where the network traffic will be load balanced fromtrue
accountthe account associated with the load balancer. Must be used with the domainId parameter.false
cidrlistthe cidr list to forward traffic fromfalse
descriptionthe description of the load balancer rulefalse
domainidthe domain ID associated with the load balancerfalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
networkidThe guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)false
openfirewallif true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to truefalse
protocolThe protocol for the LBfalse
publicipidpublic ip address id from where the network traffic will be load balanced fromfalse
zoneidzone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVmfalse

Response Tags

Response NameDescription
idthe load balancer rule ID
accountthe account of the load balancer rule
algorithmthe load balancer algorithm (source, roundrobin, leastconn)
cidrlistthe cidr list to forward traffic from
descriptionthe description of the load balancer
domainthe domain of the load balancer rule
domainidthe domain ID of the load balancer rule
fordisplayis rule for display to the regular user
namethe name of the load balancer
networkidthe id of the guest network the lb rule belongs to
privateportthe private port
projectthe project name of the load balancer
projectidthe project id of the load balancer
protocolthe protocol of the loadbalanacer rule
publicipthe public ip address
publicipidthe public ip address id
publicportthe public port
statethe state of the rule
zoneidthe id of the zone the rule belongs to
tags(*)the list of resource tags associated with load balancer
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value