Previous page

Next page

Locate page in Contents

Print this page

get

Summary:

Retrieves the most recently collected performance data.

Request specification:

Name

Min/Max

Type

Description

get

 

 

 

{

 

 

 

eid_list

1..1

eid_listType

A list containing the IDs of the servers for which to retrieve the performance data. If this element is empty, the data for all known servers will be retrieved, including the Hardware Node and all of the Virtuozzo Containers that it hosts.

class

1..[]

classType

The list of the performance classes, instances, and counters to get the data for. You have to make sure that the classes and the counters specified here are compatible with the servers specified in the eid_list element.

The following rules apply when selecting classes and counters:

  • If the eid_list element contains just the Hardware Node, the classes must be of the generic type.
  • If the list contains Virtuozzo Containers only, the classes must be of the virtuozzo type.
  • If the eid_list element is empty, you may mix classes and counters of both types -- the performance monitor will choose the correct classes and the counters from the list for each server type automatically.
  • If you mix a Hardware Node and Virtuozzo Containers in the same list, you have to make sure that each of the specified counters is compatible with both server types (i.e. a counter with this name exists in both virtuozzo and generic lists). Failure to do so may give you unpredictable output. Normally, we don't recommend mixing servers of different types in the same request. If you really need to get performance data for the Hardware Node and Virtuozzo Containers in one call, use the scenario where an empty eid_list element is used (described above).

}

 

 

 

Returns:

Name

Min/Max

Type

Description

data

1..[]

perf_dataType

Performance data.

Description:

The performance data is collected by Agent for all running servers at the predefined time intervals (a few seconds) and is stored in a temporary storage buffer. The get call allows to retrieve the most recently collected data. This is an on-demand request. It produces a single response containing the latest performance data. If you would like to receive the performance reports on a periodic basis, use the start_monitor call instead. If you are using the Parallels Agent SOAP API, use this call to obtain performance statistics.

Please also see the perf_mon section for more information on classes, instances, and counters.

Example:

The following example shows how to get the latest performance data for the specified server using the specified class and counter.

Input

<packet version="4.0.0" id="2">

<target>perf_mon</target>

<data>

<perf_mon>

<get>

<eid_list>

<eid>1649d32f-3e18-6642-9690-4fe3cd406eb0</eid>

</eid_list>

<class>

<name>counters_vz_cpu</name>

<instance>

<counter>counter_cpu_system</counter>

</instance>

</class>

</get>

</perf_mon>

</data>

</packet>

Output

<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/perf_mon" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="3fc4683bf1bt54derb2c" time="2007-06-28T17:39:58+0000" priority="0" version="4.0.0">

<ns1:origin>perf_mon</ns1:origin>

<ns1:target>vzclient1-6d9ea6b6-e470-424b-98ca-27dd10e49860</ns1:target>

<ns1:dst>

<ns1:director>gend</ns1:director>

</ns1:dst>

<ns1:data>

<ns2:perf_mon>

<ns2:data>

<ns2:eid>1649d32f-3e18-6642-9690-4fe3cd406eb0</ns2:eid>

<ns2:interval>

<ns2:start_time>2007-06-28T17:21:59+0000</ns2:start_time>

<ns2:end_time>2007-06-28T17:39:39+0000</ns2:end_time>

</ns2:interval>

<ns2:class>

<ns2:name>counters_vz_cpu</ns2:name>

<ns2:instance>

<ns2:name></ns2:name>

<ns2:counter>

<ns2:name>counter_cpu_system</ns2:name>

<ns2:value>

<ns2:avg>215</ns2:avg>

<ns2:min>215</ns2:min>

<ns2:max>215</ns2:max>

<ns2:cur>215</ns2:cur>

</ns2:value>

</ns2:counter>

</ns2:instance>

</ns2:class>

</ns2:data>

</ns2:perf_mon>

</ns1:data>

<ns1:src>

<ns1:director>gend</ns1:director>

</ns1:src>

</ns1:packet>

Please send us your feedback on this help page