| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" href="../includes/main.css" type="text/css"> |
| <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> |
| <title>Apache CloudStack | The Power Behind Your Cloud</title> |
| </head> |
| <body> |
| <div id="insidetopbg"> |
| <div id="inside_wrapper"> |
| <div class="uppermenu_panel"> |
| <div class="uppermenu_box"></div> |
| </div> |
| <div id="main_master"> |
| <div id="inside_header"> |
| <div class="header_top"> |
| <a class="cloud_logo" href="http://cloudstack.org"></a> |
| <div class="mainemenu_panel"></div> |
| </div> |
| </div> |
| <div id="main_content"> |
| <div class="inside_apileftpanel"> |
| <div class="inside_contentpanel" style="width:930px;"> |
| <div class="api_titlebox"> |
| <div class="api_titlebox_left"> |
| <span> |
| Apache CloudStack v4.1.0 Domain Admin API Reference |
| </span> |
| <p></p> |
| <h1>createLoadBalancerRule</h1> |
| <p>Creates a load balancer rule</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> |
| </div> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Request parameters</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>algorithm</strong></td><td style="width:500px;"><strong>load balancer algorithm (source, roundrobin, leastconn)</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>name of the load balancer rule</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>privateport</strong></td><td style="width:500px;"><strong>the private port of the private ip address/virtual machine where the network traffic will be load balanced to</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicport</strong></td><td style="width:500px;"><strong>the public port from where the network traffic will be load balanced from</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the account associated with the load balancer. Must be used with the domainId parameter.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>cidrlist</i></td><td style="width:500px;"><i>the cidr list to forward traffic from</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>description</i></td><td style="width:500px;"><i>the description of the load balancer rule</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>the domain ID associated with the load balancer</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>networkid</i></td><td style="width:500px;"><i>The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>openfirewall</i></td><td style="width:500px;"><i>if 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 true</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>publicipid</i></td><td style="width:500px;"><i>public ip address id from where the network traffic will be load balanced from</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| </table> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Response Tags</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the load balancer rule ID</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account of the load balancer rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>algorithm</strong></td><td style="width:500px;">the load balancer algorithm (source, roundrobin, leastconn)</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cidrlist</strong></td><td style="width:500px;">the cidr list to forward traffic from</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>description</strong></td><td style="width:500px;">the description of the load balancer</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain of the load balancer rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the load balancer rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the load balancer</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>privateport</strong></td><td style="width:500px;">the private port</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the load balancer</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the load balancer</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">the public ip address</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicipid</strong></td><td style="width:500px;">the public ip address id</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>publicport</strong></td><td style="width:500px;">the public port</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the rule</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the id of the zone the rule belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with load balancer</td> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> |
| </tr> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer_mainmaster"> |
| <p>Copyright © 2012 The Apache Software Foundation, Licensed under the |
| <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a> |
| <br> |
| Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
