Summary:
Retrieves a list of the top resource consuming servers.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
|
|
|
|
|
|
|
|
|
The name of the "top" counter to use. The available counters are defined in the Agent vocabulary. To retrieve the list of counters, use the |
|
|
|
If set, specifies the maximum number of servers to include in the report. |
|
|
|
If this element is present, the records will be sorted in descending order. |
|
|
|
Start time of the log. |
|
|
|
End time of the log. |
|
|
The IDs of the servers to include in the report. If this element is omitted, all known servers will be included (the total number of the servers may be limited by the value provided in the |
|
|
|
|
If this element is included, the list specified in the |
|
|
|
|
Returns:
Name |
Min/Max |
Type |
Description |
|
|
|
A list of the top resource-consuming servers. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Server ID. |
|
|
|
|
The specified resource consumption value. |
|
|
|
|
|
|
|
An aggregate resource consumption value for all servers. |
|
|
|
|
Description:
The resource type for which you want to retrieve the data is specified in the parameter
element and is the name of one of the counters. The following table describes the most common counters.
Counter name |
Type |
Units |
Description |
CPU |
|
|
|
|
|
percent |
CPU usage. |
|
|
percent |
The ratio of CPU time consumed by the server to current limit. |
Disk |
|
|
|
|
|
bytes |
Disk space used. |
|
|
percent |
The ratio of used disk space to current limit. |
Memory |
|
|
|
|
|
bytes |
Memory used by the server. |
|
|
percent |
The ratio of used memory to current limit. |
Network |
|
|
|
|
|
percent |
Incoming network bandwidth usage. (The ratio of received bytes to current limit). |
|
|
percent |
Outgoing network bandwidth usage. (The ratio of sent bytes to current limit). |
The complete list of counters can be retrieved from the vocabulary by executing the following XML request:
<packet version="4.0.0" id="2">
<data>
<system>
<get_vocabulary>
<category>top_counters</category>
</get_vocabulary>
</system>
</data>
</packet>
Example:
The following example shows how to retrieve the top CPU consuming servers.
Input
<packet version="4.0.0">
<target>res_log</target>
<data>
<res_log>
<get_top>
<parameter>counter_cpu_used</parameter>
<descending/>
</get_top>
</res_log>
</data>
</packet>
Output
<ns1:packet xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/res_log" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="1dc45f96e29t4db7r4e4" time="2007-03-12T16:21:24+0000" priority="0" version="4.0.0">
<ns1:origin>res_log</ns1:origin>
<ns1:target>vzclient8</ns1:target>
<ns1:dst>
<ns1:director>gend</ns1:director>
</ns1:dst>
<ns1:data>
<ns2:res_log>
<ns2:top>
<ns2:set>
<ns2:eid>565b96bd-d2da-4c7e-a212-0943a4bd6b29</ns2:eid>
<ns2:value>1.281462</ns2:value>
</ns2:set>
<ns2:set>
<ns2:eid>ef740db8-51d9-453e-ab55-63dc24e23706</ns2:eid>
<ns2:value>0.032165</ns2:value>
</ns2:set>
<ns2:set>
<ns2:eid>9bafbeb7-85f7-499e-a210-40e00850a5f3</ns2:eid>
<ns2:value>0.005164</ns2:value>
</ns2:set>
<ns2:total>1.318791</ns2:total>
</ns2:top>
</ns2:res_log>
</ns1:data>
<ns1:src>
<ns1:director>gend</ns1:director>
</ns1:src>
</ns1:packet>