Apache CloudStack 4.20.0.0 Root Admin API Reference
listGlobalLoadBalancerRules
Lists load balancer rules.
Request parameters
| Parameter Name | Description | Required |
| account | list resources by account. Must be used with the domainId parameter. | false |
| domainid | list only resources belonging to the domain specified | false |
| id | the ID of the global load balancer rule | false |
| isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If 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 false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| page | false | |
| pagesize | false | |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| regionid | region ID | false |
| tags | List resources by tags (key/value pairs) | false |
Response Tags
| Response Name | Description |
| id | global load balancer rule ID |
| account | the account of the load balancer rule |
| description | the description of the global load balancer rule |
| domain | the domain of the load balancer rule |
| domainid | the domain ID of the load balancer rule |
| domainpath | path of the domain to which the load balancer rule belongs |
| gslbdomainname | DNS domain name given for the global load balancer |
| gslblbmethod | Load balancing method used for the global load balancer |
| gslbservicetype | GSLB service type |
| gslbstickysessionmethodname | session persistence method used for the global load balancer |
| name | name of the global load balancer rule |
| project | the project name of the load balancer |
| projectid | the project id of the load balancer |
| regionid | Region Id in which global load balancer is created |
| loadbalancerrule(*) | List of load balancer rules that are part of GSLB rule |
| id | the load balancer rule ID |
| account | the account of the load balancer rule |
| algorithm | the load balancer algorithm (source, roundrobin, leastconn) |
| cidrlist | the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). |
| description | the description of the load balancer |
| domain | the domain of the load balancer rule |
| domainid | the domain ID of the load balancer rule |
| domainpath | path of the domain to which the load balancer rule belongs |
| fordisplay | is rule for display to the regular user |
| name | the name of the load balancer |
| networkid | the id of the guest network the lb rule belongs to |
| privateport | the private port |
| project | the project name of the load balancer |
| projectid | the project id of the load balancer |
| protocol | the protocol of the loadbalanacer rule |
| publicip | the public ip address |
| publicipid | the public ip address id |
| publicport | the public port |
| state | the state of the rule |
| zoneid | the id of the zone the rule belongs to |
| zonename | the name of the zone the load balancer rule belongs to |
| tags(*) | the list of resource tags associated with load balancer |
| account | the account associated with the tag |
| customer | customer associated with the tag |
| domain | the domain associated with the tag |
| domainid | the ID of the domain associated with the tag |
| domainpath | path of the Domain associated with the tag |
| key | tag key name |
| project | the project name where tag belongs to |
| projectid | the project id the tag belongs to |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |