Jump to

• Request
• Response

Get a List of Alarms

get

/rest/{versionId}/fault/alarms

Use this (GET) method to 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

• versionId: string

Query Parameters

• endTime(optional): string
• limitation(optional): string
• offset(optional): string
• severity(optional): string
• source(optional): string
• sourceIp(optional): string
• startTime(optional): string
• type(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object AlarmDetail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AlarmDetail"
    }
}

Nested Schema : AlarmDetail

Type: object

Show Source

• acknowledgedBy(optional): string
• annotation(optional): string
• description(optional): string
• failedResource(optional): string
• modifiedTime(optional): string
• nfName(optional): string
• objectId(optional): string
• severity(optional): string
• source(optional): string
• sourceGroupId(optional): string
• sourceIp(optional): string
• sysUpTime(optional): string
• time(optional): string
• trapName(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "objectId":{
            "type":"string"
        },
        "time":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "sourceIp":{
            "type":"string"
        },
        "nfName":{
            "type":"string"
        },
        "severity":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "acknowledgedBy":{
            "type":"string"
        },
        "modifiedTime":{
            "type":"string"
        },
        "trapName":{
            "type":"string"
        },
        "failedResource":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "sourceGroupId":{
            "type":"string"
        },
        "sysUpTime":{
            "type":"string"
        },
        "annotation":{
            "type":"string"
        }
    }
}

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