1. REST API for Session Delivery Manager Release 9.0.1 and newer
  2. Tasks
  3. fault

Get a List of Alarms

get

/{versionId}/fault/alarms

Retrieve alarms maintained by the fault management system in the SDM database. These alarms originate from events that SDM generated or were received from all the devices that Session Element Manager is managing. The query for alarms can be filtered by using the query parameters provided in the request.

Request

Path Parameters
Query Parameters
Back to Top

Response

200 Response

OK

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a session cookie.

The following example shows how to get a list of alarms using curl.

curl -X GET \
    -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/fault/alarms"

The following example shows how to get a list of alarms using Python.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/fault/alarms"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alarmDetails>
  <alarmDetail>
      <acknowledgedBy></acknowledgedBy>
      <annotation></annotation>
      <category>Hardware</category>
      <description>Hardware error = CAM subsystems.</description>
      <failedResource>Hardware</failedResource>
      <nfName>sd68</nfName>
      <objectId>31</objectId>
      <severity>Critical</severity>
      <source>sd68</source>
      <sourceGroupId>ID3</sourceGroupId>
      <sourceIp>10.123.140.68</sourceIp>
      <sysUpTime>0 days, 0 hours, 8 minutes, 20 seconds</sysUpTime>
      <time>Fri Sep 20 16:58:39 UTC 2024</time>
      <trapName>apSysMgmtHardwareErrorTrap</trapName>
  </alarmDetail>
  <alarmDetail>
      <acknowledgedBy></acknowledgedBy>
      <annotation></annotation>
      <category>Gateway</category>
      <description>Gateway: 11.11.11.1 gateway has been resynchronized.</description>
      <failedResource>11.11.11.1</failedResource>
      <nfName>sd68</nfName>
      <objectId>28</objectId>
      <severity>Major</severity>
      <source>sd68</source>
      <sourceGroupId>ID3</sourceGroupId>
      <sourceIp>10.123.140.68</sourceIp>
      <sysUpTime>0 days, 0 hours, 8 minutes, 20 seconds</sysUpTime>
      <time>Fri Sep 20 16:58:39 UTC 2024</time>
      <trapName>apSysMgmtGatewaySynchronizedTrap</trapName>
  </alarmDetail>
  <alarmDetail>
      <acknowledgedBy></acknowledgedBy>
      <annotation></annotation>
      <category>Media realm</category>
      <description>Media process cannot find associated realm for flow.</description>
      <failedResource>Realm</failedResource>
      <nfName>sd68</nfName>
      <objectId>24</objectId>
      <severity>Minor</severity>
      <source>sd68</source>
      <sourceGroupId>ID3</sourceGroupId>
      <sourceIp>10.123.140.68</sourceIp>
      <sysUpTime>0 days, 0 hours, 8 minutes, 20 seconds</sysUpTime>
      <time>Fri Sep 20 16:58:36 UTC 2024</time>
      <trapName>apSysMgmtMediaUnknownRealm</trapName>
  </alarmDetail>
</alarmDetails>

The following example shows the contents of the response body in JSON.

[
 {
  "acknowledgedBy": "",
  "annotation": "",
  "category": "Hardware",
  "description": "Hardware error = CAM subsystems.",
  "failedResource": "Hardware",
  "nfName": "sd68",
  "objectId": "31",
  "severity": "Critical",
  "source": "sd68",
  "sourceGroupId": "ID3",
  "sourceIp": "10.123.140.68",
  "sysUpTime": "0 days, 0 hours, 8 minutes, 20 seconds",
  "time": "Fri Sep 20 16:58:39 UTC 2024",
  "trapName": "apSysMgmtHardwareErrorTrap"
 },
 {
  "acknowledgedBy": "",
  "annotation": "",
  "category": "Gateway",
  "description": "Gateway: 11.11.11.1 gateway has been resynchronized.",
  "failedResource": "11.11.11.1",
  "nfName": "sd68",
  "objectId": "28",
  "severity": "Major",
  "source": "sd68",
  "sourceGroupId": "ID3",
  "sourceIp": "10.123.140.68",
  "sysUpTime": "0 days, 0 hours, 8 minutes, 20 seconds",
  "time": "Fri Sep 20 16:58:39 UTC 2024",
  "trapName": "apSysMgmtGatewaySynchronizedTrap"
 },
 {
  "acknowledgedBy": "",
  "annotation": "",
  "category": "Media realm",
  "description": "Media process cannot find associated realm for flow.",
  "failedResource": "Realm",
  "nfName": "sd68",
  "objectId": "24",
  "severity": "Minor",
  "source": "sd68",
  "sourceGroupId": "ID3",
  "sourceIp": "10.123.140.68",
  "sysUpTime": "0 days, 0 hours, 8 minutes, 20 seconds",
  "time": "Fri Sep 20 16:58:36 UTC 2024",
  "trapName": "apSysMgmtMediaUnknownRealm"
 }
]
Back to Top