alertHistoryResponse Type

alertHistoryResponse is returned for all alert history operations.

alertHistoryResponse always contains the following common elements:
  • authToken
  • resultCount
  • statusCode
  • statusMessage
  • summaryOnly

In getAlertHistory operation, if resultCount is greater than 0 and statusCode is 2000 (successful), the resultSet element that holds alert logs is included after resultCount.

The attributes of an alert log are:

Alert log attributes
Attributes Description Type
key Used to identify a unique log. It can be used in acknowledgeAlertHistoryByKey or removeAlertHistoryByKey operations. The user can obtain this by calling getAlertHistory. string
time The date when the alert was triggered. It corresponds to the Time field on Show Triggered Alerts page. date
sourceIp Corresponds to the Source IP field on Show Triggered Alerts page.

If only one device is configured to the alert, the sourceIP is the device IP address and if multiple devices are configured, then the sourceIP is the device group value.

string
msgType Corresponds to the Type field on Show Triggered Alerts page. string
notifyType Possible values are 1, 2, 3 for email alert, snmp alert, and no notification, respectively. number
emailRcpt Email Receipt for the triggered alert. It corresponds to the Alert Destination field on Show Triggered Alerts page when email alert is used.

If multiple email addresses are used, then they are separated by a comma.

string
trapReceiver Corresponds to the Alert Destination field on Show Triggered Alerts page when snmp alert is used. string
message The alert message body. string
priority Possible values are 0, 1, 2 for priority low, medium, and high, respectively. number
ArchiveFlag Possible values are 0, 1 for unacknowledged alert logs and acknowledged alert logs, respectively. number
ApplianceIp Corresponds to the Appliance field on Show Triggered Alerts page. This field is visible on the Show Triggered Alerts page when you view alert logs from a Management Station. string

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage.

Example

Example of alertHistoryResponse Type: 
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getAlertHistoryResponse xmlns:ns="AlertService">
         <ns:return xsi:type="ax27:AlertHistoryResponse" xmlns:ax27="http://alert.services.logapp.loglogic.com/xsd" xmlns:ax28="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax28:authToken xsi:nil="true"/>
            <ax28:resultCount>9</ax28:resultCount>
            <ax28:statusCode>2000</ax28:statusCode>
            <ax28:statusMessage>Successful</ax28:statusMessage>
            <ax28:summaryOnly>true</ax28:summaryOnly>
            <ax27:resultSet xsi:type="ax27:AlertLog">
               <ax27:applianceIp>10.114.81.43</ax27:applianceIp>
               <ax27:archiveFlag>0</ax27:archiveFlag>
               <ax27:emailRcpt/>
               <ax27:key>9:1:1552273720:10.114.81.43</ax27:key>
               <ax27:message>Alert 'TEST2'  was generated by 10.114.81.43
for the following device(s): All Other UNIX, All LogLogic Logu, All LogLogic Appliance, All General Syslog, ::ffff:10.114.81.43_otherUnix, ::ffff:10.114.81.43_logapp, ::ffff:127.0.0.1_General, ::1_logapp, ::ffff:10.114.81.43_logu..
Alert was configured for All Other UNIX, All LogLogic Logu, All LogLogic Appliance, All General Syslog, ::ffff:10.114.81.43_otherUnix, ::ffff:10.114.81.43_logapp, ::ffff:127.0.0.1_General, ::1_logapp, ::ffff:10.114.81.43_logu.
Current message rate: 0.67msgs/s. Low threshold: 45msgs/s. Reset time: 60s.
Subsequent alerts will not be sent until 60 seconds have passed.
There were 0 alertable events since last alert message.</ax27:message>
               <ax27:msgType>Message Volume Alert</ax27:msgType>
               <ax27:notifyType>0</ax27:notifyType>
               <ax27:priority>1</ax27:priority>
               <ax27:sourceIp>Device group</ax27:sourceIp>
               <ax27:time>2019-03-10T20:08:40.000-07:00</ax27:time>
               <ax27:trapReceiver xsi:nil="true"/>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertLog">
               <ax27:applianceIp>10.114.81.43</ax27:applianceIp>
               <ax27:archiveFlag>0</ax27:archiveFlag>
               <ax27:emailRcpt/>
               <ax27:key>8:1:1552273660:10.114.81.43</ax27:key>
               <ax27:message>Alert 'TEST2'  was generated by 10.114.81.43
for the following device(s): All Other UNIX, All LogLogic Logu, All LogLogic Appliance, All General Syslog, ::ffff:10.114.81.43_otherUnix, ::ffff:10.114.81.43_logapp, ::ffff:127.0.0.1_General, ::1_logapp, ::ffff:10.114.81.43_logu..
Alert was configured for All Other UNIX, All LogLogic Logu, All LogLogic Appliance, All General Syslog, ::ffff:10.114.81.43_otherUnix, ::ffff:10.114.81.43_logapp, ::ffff:127.0.0.1_General, ::1_logapp, ::ffff:10.114.81.43_logu.
Current message rate: 0.77msgs/s. Low threshold: 45msgs/s. Reset time: 60s.
Subsequent alerts will not be sent until 60 seconds have passed.
There were 0 alertable events since last alert message.</ax27:message>
               <ax27:msgType>Message Volume Alert</ax27:msgType>
               <ax27:notifyType>0</ax27:notifyType>
               <ax27:priority>1</ax27:priority>
               <ax27:sourceIp>Device group</ax27:sourceIp>
               <ax27:time>2019-03-10T20:07:40.000-07:00</ax27:time>
               <ax27:trapReceiver xsi:nil="true"/>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertLog">
               <ax27:applianceIp>10.114.81.43</ax27:applianceIp>
               <ax27:archiveFlag>0</ax27:archiveFlag>
               <ax27:emailRcpt/>
               <ax27:key>7:1:1552273600:10.114.81.43</ax27:key>
               <ax27:message>Alert 'TEST2'  was generated by 10.114.81.43
for the following device(s): All Other UNIX, All LogLogic Logu, All LogLogic Appliance, All General Syslog, ::ffff:10.114.81.43_otherUnix, ::ffff:10.114.81.43_logapp, ::ffff:127.0.0.1_General, ::1_logapp, ::ffff:10.114.81.43_logu..
Alert was configured for All Other UNIX, All LogLogic Logu, All LogLogic Appliance, All General Syslog, ::ffff:10.114.81.43_otherUnix, ::ffff:10.114.81.43_logapp, ::ffff:127.0.0.1_General, ::1_logapp, ::ffff:10.114.81.43_logu.
Current message rate: 0.67msgs/s. Low threshold: 45msgs/s. Reset time: 60s.
Subsequent alerts will not be sent until 60 seconds have passed.
There were 0 alertable events since last alert message.</ax27:message>
               <ax27:msgType>Message Volume Alert</ax27:msgType>
               <ax27:notifyType>0</ax27:notifyType>
               <ax27:priority>1</ax27:priority>
               <ax27:sourceIp>Device group</ax27:sourceIp>
               <ax27:time>2019-03-10T20:06:40.000-07:00</ax27:time>
               <ax27:trapReceiver xsi:nil="true"/>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertLog">
               <ax27:applianceIp>10.114.81.43</ax27:applianceIp>