Apache CloudStack v4.4.0 Domain Admin API Reference

listGlobalLoadBalancerRules

Lists load balancer rules.

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idthe ID of the global load balancer rulefalse
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
pagefalse
pagesizefalse
projectidlist objects by projectfalse
regionidregion IDfalse
tagsList resources by tags (key/value pairs)false

Response Tags

Response NameDescription
idglobal load balancer rule ID
accountthe account of the load balancer rule
descriptionthe description of the global load balancer rule
domainthe domain of the load balancer rule
domainidthe domain ID of the load balancer rule
gslbdomainnameDNS domain name given for the global load balancer
gslblbmethodLoad balancing method used for the global load balancer
gslbservicetypeGSLB service type
gslbstickysessionmethodnamesession persistence method used for the global load balancer
namename of the global load balancer rule
projectthe project name of the load balancer
projectidthe project id of the load balancer
regionidRegion Id in which global load balancer is created
loadbalancerrule(*)List of load balancer rules that are part of GSLB rule
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