Dell Technologies ECS REST API

Search (SHIFT+S)




Get Alerts

GET /vdc/alerts

Gets the list of alerts Following filter could be used: start_time, end_time, namespace, severity, type limit and marker could be specified for pagination


Query Parameters

start_timeStart time for listing alerts
end_timeEnd time for listing alerts
namespaceNamespace for which alerts should be listed
markerReference to last alert returned
limitNumber of alerts requested in current fetch
severitySeverity of alerts to be listed
typeType of alerts to be listed
acknowledged

Required Roles

This call has no restrictions.


Response Body

List of alerts based on the given parameters

Field Description Type Notes
alerts
alert     0-* Elements
id Event id String
type alert type String
severity alert severity String
timestamp Event creating time of yyyy-MM-dd'T'HH:mm:ss format. String
namespace Namespace for this event String
description Description for this alert String
symptomCode Symptom Code String
acknowledged acknowledgement state of alert Boolean
MaxAlerts Integer
NextMarker String
Filter String
NextPageLink String

Examples

Request
GET https://192.168.0.0:4443/vdc/alerts HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alerts>
    <alert>
        <acknowledged>false</acknowledged>
        <type>RPO</type>
        <description>RPO for replication group GlobalReplicationGroup is 1 hour 7 minutes 51 seconds greater than 1 hour  threshold set.  [Ref_ID : RPO]</description>
        <id>urn:storageos:Alert:1dc361f7-0178-1524-ab4e-b8d06497c671</id>
        <namespace></namespace>
        <severity>WARNING</severity>
        <symptomCode>1012</symptomCode>
        <timestamp>2021-03-10T20:10:47</timestamp>
    </alert>
    <alert>
        <acknowledged>false</acknowledged>
        <type>RPO</type>
        <description>RPO for replication group globalrep2 is 1 hour 8 minutes 9 seconds greater than 1 hour  threshold set.  [Ref_ID : RPO]</description>
        <id>urn:storageos:Alert:1dc361f7-0178-1524-ab4e-b8d06497c672</id>
        <namespace></namespace>
        <severity>WARNING</severity>
        <symptomCode>1012</symptomCode>
        <timestamp>2021-03-10T20:10:49</timestamp>
    </alert>
</alerts>