Apache CloudStack v4.4.1 Root Admin API Reference


Lists Load Balancers

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idthe ID of the Load Balancerfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
namethe name of the Load Balancerfalse
networkidthe network id of the Load Balancerfalse
projectidlist objects by projectfalse
schemethe scheme of the Load Balancer. Supported value is Internal in the current releasefalse
sourceipaddressthe source ip address of the Load Balancerfalse
sourceipaddressnetworkidthe network id of the source ip addressfalse
tagsList resources by tags (key/value pairs)false

Response Tags

Response NameDescription
idthe Load Balancer ID
accountthe account of the Load Balancer
algorithmthe load balancer algorithm (source, roundrobin, leastconn)
descriptionthe description of the Load Balancer
domainthe domain of the Load Balancer
domainidthe domain ID of the Load Balancer
fordisplayis rule for display to the regular user
namethe name of the Load Balancer
networkidLoad Balancer network id
projectthe project name of the Load Balancer
projectidthe project id of the Load Balancer
sourceipaddressLoad Balancer source ip
sourceipaddressnetworkidLoad Balancer source ip network id
loadbalancerinstance(*)the list of instances associated with the Load Balancer
idthe instance ID
ipaddressthe ip address of the instance
namethe name of the instance
statethe state of the instance
loadbalancerrule(*)the list of rules associated with the Load Balancer
instanceportinstance port of the load balancer rule
sourceportsource port of the load balancer rule
statethe state of the load balancer rule
tags(*)the list of resource tags associated with the 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