| <!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>listZones</h1> |
| <p>Lists zones</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;"><i>available</i></td><td style="width:500px;"><i>true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.</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 ID of the domain associated with the zone</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>the ID of the zone</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>the name of the zone</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>showcapacities</i></td><td style="width:500px;"><i>flag to display the capacity of the zones</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;">Zone id</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>allocationstate</strong></td><td style="width:500px;">the allocation state of the cluster</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>description</strong></td><td style="width:500px;">Zone description</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>dhcpprovider</strong></td><td style="width:500px;">the dhcp Provider for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">the display text of the zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>dns1</strong></td><td style="width:500px;">the first DNS for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>dns2</strong></td><td style="width:500px;">the second DNS for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">Network domain name for the networks in the zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the UUID of the containing domain, null for public zones</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainname</strong></td><td style="width:500px;">the name of the containing domain, null for public zones</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>guestcidraddress</strong></td><td style="width:500px;">the guest CIDR address for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>internaldns1</strong></td><td style="width:500px;">the first internal DNS for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>internaldns2</strong></td><td style="width:500px;">the second internal DNS for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip6dns1</strong></td><td style="width:500px;">the first IPv6 DNS for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ip6dns2</strong></td><td style="width:500px;">the second IPv6 DNS for the Zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>localstorageenabled</strong></td><td style="width:500px;">true if local storage offering enabled, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">Zone name</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networktype</strong></td><td style="width:500px;">the network type of the zone; can be Basic or Advanced</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>securitygroupsenabled</strong></td><td style="width:500px;">true if security groups support is enabled, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>vlan</strong></td><td style="width:500px;">the vlan range of the zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zonetoken</strong></td><td style="width:500px;">Zone Token</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>capacity(*)</strong></td><td style="width:500px;">the capacity of the Zone</td> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>capacitytotal</strong></td><td style="width:500px;">the total capacity available</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>capacityused</strong></td><td style="width:500px;">the capacity currently in use</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>clusterid</strong></td><td style="width:500px;">the Cluster ID</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>clustername</strong></td><td style="width:500px;">the Cluster name</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>percentused</strong></td><td style="width:500px;">the percentage of capacity currently in use</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>podname</strong></td><td style="width:500px;">the Pod name</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the capacity type</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name</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> |