Previous page

Next page

Locate page in Contents

Print this page

get_top

Summary:

Retrieves a list of the top resource consuming servers.

Request specification:

Name

Min/Max

Type

Description

get_top

1..1

 

 

{

 

 

 

parameter

1..1

string

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 top_counters category. The counter here must be compatible with the servers specified in the eid_list element (below).

count

0..1

int

If set, specifies the maximum number of servers to include in the report.

descending

0..1

none

If this element is present, the records will be sorted in descending order.

start_time

0..1

datetime_type

Start time of the log.

end_time

0..1

datetime_type

End time of the log.

eid_list

0..1

eid_listType

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 count element if present).

exclude

0..1

none

If this element is included, the list specified in the eid_list element will be treated as the list of the servers to exclude from the report.

}

 

 

 

Returns:

Name

Min/Max

Type

Description

top

0..1

 

A list of the top resource-consuming servers.

{

 

 

 

set

0..[]

 

 

{

 

 

 

eid

1..1

eid_type

Server ID.

value

1..1

anySimpleType

The specified resource consumption value.

}

 

 

 

total

1..1

anySimpleType

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

 

 

 

counter_cpu_used

float

percent

CPU usage.

counter_cpu_share_used

float

percent

The ratio of CPU time consumed by the server to current limit.

Disk

 

 

 

counter_disk_used

int

bytes

Disk space used.

counter_disk_share_used

float

percent

The ratio of used disk space to current limit.

Memory

 

 

 

counter_memory_used

int

bytes

Memory used by the server.

counter_memory_share_used

float

percent

The ratio of used memory to current limit.

Network

 

 

 

counter_net_incoming_rate

float

percent

Incoming network bandwidth usage. (The ratio of received bytes to current limit).

counter_net_outgoing_rate

float

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>

Please send us your feedback on this help page