Loading...

REST API - GET Console Alert

This operation returns a list of console alerts.

Request

Syntax

GET <webservice>/Alert?pageNo={pageNo}&pageCount={pageCount} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

pageNo

The starting page number.

Yes

pageCount

The number of pages to return in the response. Each page contains 200 console alerts.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

numberOfNewAlert

The total number of unread alerts.

App_LiveFeedListResp

totalNoOfAlerts

The total number of alerts.

App_LiveFeedListResp

alertName

The name of the alert.

feedsList

alertType

The alert category and the alert type, for example, Job Management - Data Recovery.

feedsList

alertcriteria

The alert criteria.

Valid values are:

Alert CommServe License Expires Within n Days

Job Skipped

Alert every n attempts (Network failures)

Job Started

Alert every n attempts (Phase failures)

Job Succeeded

Alert every n failed login attempts

Job Succeeded with Errors

Alert Modified

Library went Offline

Alert when client certificate Expires Within n Days

Maintenance Occurred

Alert when jobs in pending state exceed n percent or count of n

Maintenance Required

Alert when License Consumed reaches n Percent

Media Handling Required

Auxiliary Copy fallen behind alert

Media Picked Up

Backup for subclient failed consecutively for n attempts

Media Reached Destination

Classification Failed

Media Recalled

Data backed up exceeds n GB

Media Returned to Source

DDB disk space low

MediaAgent went offline

DDB Store got corrupted

Mount Path went Offline

Decrease in Data size by n %

No Backup for last n Days

Delayed by n Hrs

No Data Protection

Disk Space Low

Non-encrypted media exported

Drive went Offline

Number of failed files is more than n

Force De-configured

Percentage of failed files is more than n

Increase in Data size by n %

Properties Modified

Insufficient Storage

Release Upgrade Required

Job Activity

Rolled Back

Job exceeded running time of n Hrs

Scheduler Changes

Job Failed

Updates Available to Download

Job Initiated

User Overwrite of Media

 

feedsList

escalationLevel

 

feedsList

jobId

The system-generated ID assigned to the job.

feedsList

liveFeedId

The system-generated ID assigned to the console alert.

feedsList

messageFormatType

 

feedsList

notes

Any note entered for the console alert.

feedsList

ntNotificationId

 

feedsList

severity

The alert severity.

Valid values are:

  • 0, for Auto Pick
  • 1, for Critical
  • 2, for Warning
  • 3, for Information

feedsList

status

The status of the alert.

Valid values are:

  • 4, read
  • 8, unread

feedsList

clientId

The system-generated ID assigned to the client.

client

clientName

The name of the client.

client

time

The date and time the alert appeared in the Console Alerts tab.

detectedTime

timeValue

The data and time the alert was created.

detectedTime

Examples

Sample Request

GET <webservice>/Alert?pageNo=1&pageCount=200 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_LiveFeedListResp numberOfNewAlert="3" totalNoOfAlerts="3">

<feedsList alertName="Backup job activity" alertType="Job Management - Data Protection" alertcriteria="Job Activity" escalationLevel="1" jobId="2704" liveFeedId="1364" messageFormatType="1" notes="reviewed by admin" ntNotificationId="1048" severity="3" status="8">
  <client clientId="2" clientName="client001"/>
  <detectedTime time="2014-09-15 13:48:21" timeValue="Mon Sep 15 13:48:12 2014"/>
</feedsList>

<feedsList alertName="Backup job completed" alertType="Job Management - Data Protection" alertcriteria="Job Succeeded" escalationLevel="1" jobId="2644" liveFeedId="1014" messageFormatType="1" notes="" ntNotificationId="1047" severity="3" status="8">
  <client clientId="2" clientName="client001"/>
  <detectedTime time="2014-09-08 13:09:03" timeValue="Mon Sep 08 13:08:10 2014"/>
</feedsList>

<feedsList alertName="Backup job started" alertType="Job Management - Data Protection" alertcriteria="Job Started" escalationLevel="1" jobId="2644" liveFeedId="1013" messageFormatType="1" notes="" ntNotificationId="1046" severity="3" status="8">
  <client clientId="2" clientName="client001"/>
  <detectedTime time="2014-09-08 13:02:55" timeValue="Mon Sep 08 13:01:57 2014"/>
</feedsList>

</App_LiveFeedListResp>

Last modified: 4/29/2019 8:32:17 PM