blob: 913d9ccd7eb5dc1c3dbb0ae653dd85ff49e0b626 [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_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.17.0.0 Root Admin API Reference
</span>
<p></p>
<h1>listManagementServersMetrics</h1>
<p>Lists Management Server 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>id</i></td><td style="width:500px;"><i>the id of the management server</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 management server</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>system</i></td><td style="width:500px;"><i>include system level stats</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>agentcount</strong></td><td style="width:500px;">the number of agents this Management Server is responsible for</td>
</tr>
<tr>
<td style="width:200px;"><strong>availableprocessors</strong></td><td style="width:500px;">the number of processors available to the JVM</td>
</tr>
<tr>
<td style="width:200px;"><strong>collectiontime</strong></td><td style="width:500px;">the time these statistics were collected</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuload</strong></td><td style="width:500px;">the current cpu load</td>
</tr>
<tr>
<td style="width:200px;"><strong>dbislocal</strong></td><td style="width:500px;">the system is running against a local database</td>
</tr>
<tr>
<td style="width:200px;"><strong>heapmemorytotal</strong></td><td style="width:500px;">the amount of memory allocated to this Management Server</td>
</tr>
<tr>
<td style="width:200px;"><strong>heapmemoryused</strong></td><td style="width:500px;">the amount of memory used by this Management Server</td>
</tr>
<tr>
<td style="width:200px;"><strong>loginfo</strong></td><td style="width:500px;">the log files and their usage on disk</td>
</tr>
<tr>
<td style="width:200px;"><strong>sessions</strong></td><td style="width:500px;">the number of client sessions active on this Management Server</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemcycleusage</strong></td><td style="width:500px;">the system load for user, and system processes and the system idle cycles</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemloadaverages</strong></td><td style="width:500px;">the load averages for 1 5 and 15 minutes</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemmemoryfree</strong></td><td style="width:500px;">Free system memory</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemmemorytotal</strong></td><td style="width:500px;">Total system memory</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemmemoryused</strong></td><td style="width:500px;">Amount of memory used</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemmemoryvirtualsize</strong></td><td style="width:500px;">Virtual size of the fully loaded process</td>
</tr>
<tr>
<td style="width:200px;"><strong>systemtotalcpucycles</strong></td><td style="width:500px;">the total system cpu capacity</td>
</tr>
<tr>
<td style="width:200px;"><strong>threadsblockedcount</strong></td><td style="width:500px;">The number of blocked threads</td>
</tr>
<tr>
<td style="width:200px;"><strong>threadsdaemoncount</strong></td><td style="width:500px;">The number of daemon threads</td>
</tr>
<tr>
<td style="width:200px;"><strong>threadsrunnablecount</strong></td><td style="width:500px;">The number of runnable threads</td>
</tr>
<tr>
<td style="width:200px;"><strong>threadsteminatedcount</strong></td><td style="width:500px;">The number of terminated threads</td>
</tr>
<tr>
<td style="width:200px;"><strong>threadstotalcount</strong></td><td style="width:500px;">The number of threads</td>
</tr>
<tr>
<td style="width:200px;"><strong>threadswaitingcount</strong></td><td style="width:500px;">The number of waiting threads</td>
</tr>
<tr>
<td style="width:200px;"><strong>usageislocal</strong></td><td style="width:500px;">the system has a usage server running locally</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_maincontroller">
<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>