| <!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 4.14.1.0-SNAPSHOT Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>listHostsMetrics</h1> |
| <p>Lists hosts metrics</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>clusterid</i></td><td style="width:500px;"><i>lists hosts existing in particular cluster</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>details</i></td><td style="width:500px;"><i>comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>hahost</i></td><td style="width:500px;"><i>if true, list only hosts dedicated to HA</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>hypervisor</i></td><td style="width:500px;"><i>hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator</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 host</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 host</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>outofbandmanagementenabled</i></td><td style="width:500px;"><i>list hosts for which out-of-band management is enabled</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>outofbandmanagementpowerstate</i></td><td style="width:500px;"><i>list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]</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>podid</i></td><td style="width:500px;"><i>the Pod ID for the host</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>resourcestate</i></td><td style="width:500px;"><i>list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>state</i></td><td style="width:500px;"><i>the state of the host</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>type</i></td><td style="width:500px;"><i>the host type</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>virtualmachineid</i></td><td style="width:500px;"><i>lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM</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>the Zone ID for the host</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>cpuallocateddisablethreshold</strong></td><td style="width:500px;">cpu allocated disable threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpuallocatedghz</strong></td><td style="width:500px;">the total cpu allocated in Ghz</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpuallocatedthreshold</strong></td><td style="width:500px;">cpu allocated notification threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpudisablethreshold</strong></td><td style="width:500px;">cpu usage disable threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpuloadaverage</strong></td><td style="width:500px;">the average cpu load the last minute</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cputhreshold</strong></td><td style="width:500px;">cpu usage notification threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cputotalghz</strong></td><td style="width:500px;">the total cpu capacity in Ghz</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpuusedghz</strong></td><td style="width:500px;">the total cpu used in Ghz</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>instances</strong></td><td style="width:500px;">instances on the host</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memoryallocateddisablethreshold</strong></td><td style="width:500px;">memory allocated disable threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memoryallocatedgb</strong></td><td style="width:500px;">the total cpu allocated in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memoryallocatedthreshold</strong></td><td style="width:500px;">memory allocated notification threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memorydisablethreshold</strong></td><td style="width:500px;">memory usage disable threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memorythreshold</strong></td><td style="width:500px;">memory usage notification threshold exceeded</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memorytotalgb</strong></td><td style="width:500px;">the total cpu capacity in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memoryusedgb</strong></td><td style="width:500px;">the total cpu used in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkread</strong></td><td style="width:500px;">network read in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkwrite</strong></td><td style="width:500px;">network write in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>powerstate</strong></td><td style="width:500px;">out-of-band management power state</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_mainmaster"> |
| <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> |
