Previous page

Next page

Locate page in Contents

Print this page

get_alerts

Summary:

Returns current alert states for the specified servers.

Request specification:

Name

Min/Max

Type

Description

get_alerts

 

 

 

{

 

 

 

eid_list

0..1

eid_listType

Server list.

category

0..1

string

Categories of the alerts to return. Possible categories are described in the Agent vocabulary (see example of how to get the alert categories below). If this element is omitted, the call will return alerts of all known types.

env_type

0..1

string

Return alerts only for the servers of the specified type (generic, virtuozzo).

}

 

 

 

Returns:

Name

Min/Max

Type

Description

alert

0..[]

eventType

Alert information.

Description:

A server may have multiple alerts of different types raised at any given time. You can use subscriptions to receive alert notifications in real time (see subscribe and subscribe_alert), or you can retrieve all alerts that are currently raised on any given server using the get_alerts call.

To retrieve the available alert categories from the Agent vocabulary, use the following request:

Input

<packet version="4.0.0">

<data>

<system>

<get_vocabulary>

<category>alert</category>

</get_vocabulary>

</system>

</data>

</packet>

Output

The <id> element contains the alert category ID that can be used as a value of the category parameter to act as a filter.

<?xml version="1.0" encoding="UTF-8"?><packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/system" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="4.0.0" priority="0" id="4c479f5446t4ae1r6c0">

<origin>gend</origin>

<target>vzclient26-ca7c47e9-0aa6-904e-b1d8-851090716227</target>

<dst>

<director>gend</director>

</dst>

<data>

<system>

<vocabulary>

<name>generic</name>

<category>

<id>resource_alert</id>

<category>alert</category>

<short>Category, containing resource alerts.</short>

</category>

<category>

<id>server_group_alert</id>

<category>alert</category>

<short>Category, containing cluster alerts.</short>

</category>

</vocabulary>

</system>

</data>

</packet>

Example:

Input

<packet>

<target>alertm</target>

<data>

<alertm>

<get_alerts>

<eid_list>

<eid>ccc794ad-cc5d-49f2-8d84-6631263c81be</eid>

</eid_list>

</get_alerts>

</alertm>

</data>

</packet>

Output

<packet priority="0" version="4.0.0">

<origin>alertm</origin>

<target>vzclient6</target>

<dst>

<director>gend</director>

</dst>

<data>

<alertm>

<alert>

<eid>ccc794ad-cc5d-49f2-8d84-6631263c81be</eid>

<time>2006-08-18T10:27:23+0000</time>

<source>resource_alert_monitor</source>

<category>resource_alert</category>

<sid>XXX</sid>

<data>

<resource_alert>

<eid>9892b29c-31a1-4ea8-b792-91f740020306</eid>

<type>2</type>

<class>counters_vz_ubc</class>

<counter>physpages</counter>

<cur>0</cur>

<soft>0</soft>

<hard>2147483647</hard>

</resource_alert>

</data>

<info>

<message>

UmVzb3VyY2UgJXR5cGUlICVpZCUgYWxlcnQgb24gZW52aXJvbm1lbnQgJWVpZCUgY3VycmVudCB2YWx1ZTogJWN1ciUgc29mdCBsaW1pdDogJXNvZnQlIGhhcmQgbGltaXQ6ICVoYXJkJQ==

</message>

<name></name>

<translate/>

<parameter>

<message>MA==</message>

<name>cur</name>

</parameter>

<parameter>

<message>OTg5MmIyOWMtMzFhMS00ZWE4LWI3OTItOTFmNzQwMDIwMzA2</message>

<name>eid</name>

</parameter>

<parameter>

<message>MjE0NzQ4MzY0Nw==</message>

<name>hard</name>

</parameter>

<parameter>

<message>cGh5c3BhZ2Vz</message>

<name>id</name>

</parameter>

<parameter>

<message>MA==</message>

<name>soft</name>

</parameter>

<parameter>

<message>cmVk</message>

<name>type</name>

<translate/>

</parameter>

</info>

</alert>

<alert>

<eid>ccc794ad-cc5d-49f2-8d84-6631263c81be</eid>

<time>2006-08-18T10:35:34+0000</time>

<source>resource_alert_monitor</source>

<category>resource_alert</category>

<sid>XXX</sid>

<data>

<resource_alert>

<eid>13a10bc2-3ace-4bf9-ac0f-e33d98b1766d</eid>

<type>2</type>

<class>counters_vz_ubc</class>

<counter>physpages</counter>

<cur>0</cur>

<soft>0</soft>

<hard>2147483647</hard>

</resource_alert>

</data>

<info>

<message>

UmVzb3VyY2UgJXR5cGUlICVpZCUgYWxlcnQgb24gZW52aXJvbm1lbnQgJWVpZCUgY3VycmVudCB2YWx1ZTogJWN1ciUgc29mdCBsaW1pdDogJXNvZnQlIGhhcmQgbGltaXQ6ICVoYXJkJQ==

</message>

<name></name>

<translate/>

<parameter>

<message>MA==</message>

<name>cur</name>

</parameter>

<parameter>

<message>MTNhMTBiYzItM2FjZS00YmY5LWFjMGYtZTMzZDk4YjE3NjZk</message>

<name>eid</name>

</parameter>

<parameter>

<message>MjE0NzQ4MzY0Nw==</message>

<name>hard</name>

</parameter>

<parameter>

<message>cGh5c3BhZ2Vz</message>

<name>id</name>

</parameter>

<parameter>

<message>MA==</message>

<name>soft</name>

</parameter>

<parameter>

<message>cmVk</message>

<name>type</name>

<translate/>

</parameter>

</info>

</alert>

</alertm>

</data>

</packet>

Please send us your feedback on this help page