blob: f856edbb9b704222a77a102d180c739ef3b4b57f [file] [log] [blame]
<!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>listZonesMetrics</h1>
<p>Lists zone 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>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>networktype</i></td><td style="width:500px;"><i>the network type of the zone that the virtual machine belongs to</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>
<tr>
<td style="width:200px;"><i>tags</i></td><td style="width:500px;"><i>List zones by resource tags (key/value pairs)</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>clusters</strong></td><td style="width:500px;">healthy / total clusters in the zone</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuallocated</strong></td><td style="width:500px;">the total cpu allocated in Ghz</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>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>cpumaxdeviation</strong></td><td style="width:500px;">the maximum cpu deviation</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>cputotal</strong></td><td style="width:500px;">the total cpu capacity in Ghz</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuused</strong></td><td style="width:500px;">the total cpu used in Ghz</td>
</tr>
<tr>
<td style="width:200px;"><strong>memoryallocated</strong></td><td style="width:500px;">the total cpu allocated in GiB</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>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>memorymaxdeviation</strong></td><td style="width:500px;">the maximum memory deviation</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>memorytotal</strong></td><td style="width:500px;">the total cpu capacity in GiB</td>
</tr>
<tr>
<td style="width:200px;"><strong>memoryused</strong></td><td style="width:500px;">the total cpu used in GiB</td>
</tr>
<tr>
<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">state of the cluster</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&amp;page=4.2.0/rootadmin"></iframe>
</noscript>
</div>
<div id="footer_mainmaster">
<p>
Copyright &copy; 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>