Apache CloudStack 4.23.0.0 Root Admin API Reference
listLoadBalancerRules
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 |
| fordisplay | List resources by display flag; only ROOT admin is eligible to pass this parameter | false |
| id | The ID of the 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 |
| name | The name of the load balancer rule | false |
| networkid | List by Network ID the rule belongs to | false |
| page | false | |
| pagesize | false | |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| publicipid | The public IP address ID of the load balancer rule | false |
| tags | List resources by tags (key/value pairs) | false |
| virtualmachineid | The ID of the Instance of the load balancer rule | false |
| zoneid | The availability zone ID | false |
Response Tags
| Response Name | Description |
| 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 Load Balancer 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 |