static/api/apidocs-4.16/apis/listDomainChildren.html

<!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_controller"> <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 4.16.0.0 Root Admin API Reference </span> <p></p> <h1>listDomainChildren</h1> <p>Lists all children domains belonging to a specified domain</p> </div> <div class="api_titlebox_right"> <a class="api_backbutton" href="../index.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>id</i></td><td style="width:500px;"><i>list children domain by parent domain ID.</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>to return the entire tree, use the value "true". To return the first level children, use the value "false".</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>listall</i></td><td style="width:500px;"><i>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</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>list children domains by name</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>showicon</i></td><td style="width:500px;"><i>flag to display the resource icon for domains</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 ID of the domain</td> </tr> <tr> <td style="width:200px;"><strong>cpuavailable</strong></td><td style="width:500px;">the total number of cpu cores available to be created for this domain</td> </tr> <tr> <td style="width:200px;"><strong>cpulimit</strong></td><td style="width:500px;">the total number of cpu cores the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>cputotal</strong></td><td style="width:500px;">the total number of cpu cores owned by domain</td> </tr> <tr> <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date when this domain was created</td> </tr> <tr> <td style="width:200px;"><strong>domaindetails</strong></td><td style="width:500px;">details for the domain</td> </tr> <tr> <td style="width:200px;"><strong>haschild</strong></td><td style="width:500px;">whether the domain has one or more sub-domains</td> </tr> <tr> <td style="width:200px;"><strong>icon</strong></td><td style="width:500px;">Base64 string representation of the resource icon</td> </tr> <tr> <td style="width:200px;"><strong>ipavailable</strong></td><td style="width:500px;">the total number of public ip addresses available for this domain to acquire</td> </tr> <tr> <td style="width:200px;"><strong>iplimit</strong></td><td style="width:500px;">the total number of public ip addresses this domain can acquire</td> </tr> <tr> <td style="width:200px;"><strong>iptotal</strong></td><td style="width:500px;">the total number of public ip addresses allocated for this domain</td> </tr> <tr> <td style="width:200px;"><strong>level</strong></td><td style="width:500px;">the level of the domain</td> </tr> <tr> <td style="width:200px;"><strong>memoryavailable</strong></td><td style="width:500px;">the total memory (in MB) available to be created for this domain</td> </tr> <tr> <td style="width:200px;"><strong>memorylimit</strong></td><td style="width:500px;">the total memory (in MB) the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>memorytotal</strong></td><td style="width:500px;">the total memory (in MB) owned by domain</td> </tr> <tr> <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the domain</td> </tr> <tr> <td style="width:200px;"><strong>networkavailable</strong></td><td style="width:500px;">the total number of networks available to be created for this domain</td> </tr> <tr> <td style="width:200px;"><strong>networkdomain</strong></td><td style="width:500px;">the network domain</td> </tr> <tr> <td style="width:200px;"><strong>networklimit</strong></td><td style="width:500px;">the total number of networks the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>networktotal</strong></td><td style="width:500px;">the total number of networks owned by domain</td> </tr> <tr> <td style="width:200px;"><strong>parentdomainid</strong></td><td style="width:500px;">the domain ID of the parent domain</td> </tr> <tr> <td style="width:200px;"><strong>parentdomainname</strong></td><td style="width:500px;">the domain name of the parent domain</td> </tr> <tr> <td style="width:200px;"><strong>path</strong></td><td style="width:500px;">the path of the domain</td> </tr> <tr> <td style="width:200px;"><strong>primarystorageavailable</strong></td><td style="width:500px;">the total primary storage space (in GiB) available to be used for this domain</td> </tr> <tr> <td style="width:200px;"><strong>primarystoragelimit</strong></td><td style="width:500px;">the total primary storage space (in GiB) the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>primarystoragetotal</strong></td><td style="width:500px;">the total primary storage space (in GiB) owned by domain</td> </tr> <tr> <td style="width:200px;"><strong>projectavailable</strong></td><td style="width:500px;">the total number of projects available for administration by this domain</td> </tr> <tr> <td style="width:200px;"><strong>projectlimit</strong></td><td style="width:500px;">the total number of projects the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>projecttotal</strong></td><td style="width:500px;">the total number of projects being administrated by this domain</td> </tr> <tr> <td style="width:200px;"><strong>secondarystorageavailable</strong></td><td style="width:500px;">the total secondary storage space (in GiB) available to be used for this domain</td> </tr> <tr> <td style="width:200px;"><strong>secondarystoragelimit</strong></td><td style="width:500px;">the total secondary storage space (in GiB) the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>secondarystoragetotal</strong></td><td style="width:500px;">the total secondary storage space (in GiB) owned by domain</td> </tr> <tr> <td style="width:200px;"><strong>snapshotavailable</strong></td><td style="width:500px;">the total number of snapshots available for this domain</td> </tr> <tr> <td style="width:200px;"><strong>snapshotlimit</strong></td><td style="width:500px;">the total number of snapshots which can be stored by this domain</td> </tr> <tr> <td style="width:200px;"><strong>snapshottotal</strong></td><td style="width:500px;">the total number of snapshots stored by this domain</td> </tr> <tr> <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the domain</td> </tr> <tr> <td style="width:200px;"><strong>templateavailable</strong></td><td style="width:500px;">the total number of templates available to be created by this domain</td> </tr> <tr> <td style="width:200px;"><strong>templatelimit</strong></td><td style="width:500px;">the total number of templates which can be created by this domain</td> </tr> <tr> <td style="width:200px;"><strong>templatetotal</strong></td><td style="width:500px;">the total number of templates which have been created by this domain</td> </tr> <tr> <td style="width:200px;"><strong>vmavailable</strong></td><td style="width:500px;">the total number of virtual machines available for this domain to acquire</td> </tr> <tr> <td style="width:200px;"><strong>vmlimit</strong></td><td style="width:500px;">the total number of virtual machines that can be deployed by this domain</td> </tr> <tr> <td style="width:200px;"><strong>vmtotal</strong></td><td style="width:500px;">the total number of virtual machines deployed by this domain</td> </tr> <tr> <td style="width:200px;"><strong>volumeavailable</strong></td><td style="width:500px;">the total volume available for this domain</td> </tr> <tr> <td style="width:200px;"><strong>volumelimit</strong></td><td style="width:500px;">the total volume which can be used by this domain</td> </tr> <tr> <td style="width:200px;"><strong>volumetotal</strong></td><td style="width:500px;">the total volume being used by this domain</td> </tr> <tr> <td style="width:200px;"><strong>vpcavailable</strong></td><td style="width:500px;">the total number of vpcs available to be created for this domain</td> </tr> <tr> <td style="width:200px;"><strong>vpclimit</strong></td><td style="width:500px;">the total number of vpcs the domain can own</td> </tr> <tr> <td style="width:200px;"><strong>vpctotal</strong></td><td style="width:500px;">the total number of vpcs owned by domain</td> </tr> </table> </div> </div> </div> </div> </div> <div id="footer"> <div id="comments_thread"> <script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script> <noscript> <iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin"></iframe> </noscript> </div> <div id="footer_maincontroller"> <p> Copyright © 2015 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, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation. </p> </div> </div> </div> </div> </body> </html>

static/api/apidocs-4.16/apis/listDomainChildren.html (246 lines of code) (raw):