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 Corresponds to the “Time” field on Alert Viewer page. date
sourceIp Corresponds to the “Source IP” field on Alert Viewer page. string
msgType Corresponds to the “Type” field on Alert Viewer page. string
notifyType Possible values are 1, 2, 3 for email alert, snmp alert, and no notification, respectively. number
emailRcpt Corresponds to the “Alert Destination” field on Alert Viewer page when email alert is used. string
trapReceiver Corresponds to the “Alert Destination” field on Alert Viewer 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 Alert Viewer page. This will be visible on Alert Viewer 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.