Querying Alarm Details

Function

Queries and returns alarm details based on the specified alarm ID.

Syntax

Operation type: GET

URL: https://{ip}:{port}/alarmmanager/v1/alarm?id={value1}

Request message body: None

URL Parameters

**Table 1** Description
Parameter	Mandatory/Optional	Description	Value
id	Mandatory	Alarm ID	The value is an integer ranging from 1 and 2^32-1.

Usage Example

Request:

GET https://10.10.10.10:30035/alarmmanager/v1/alarm?id=1430946159

Request message body: None

Response:

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "alarmId": "0x00131001",
        "alarmName": "ALARM DEFAULT NAME",
        "alarmType": "alarm",
        "createAt": "2023-09-27T16:01:25Z",
        "detailedInformation": "ALARM DEFAULT INFO",
        "id": 1430946159,
        "impact": "ALARM DEFAULT Impact",
        "ip": "xx.xx.xx.xx",
        "serialNumber": "xxxxxxxxxxxxxx",
        "perceivedSeverity": "MAJOR",
        "reason": "ALARM DEFAULT Reason",
        "resource": "ALARM DEFAULT RESOURCE",
        "suggestion": "ALARM DEFAULT SUGGESTION"
    }
}

Response status code: 200

Output Description

**Table 2** Operation output description
Parameter	Type	Description
status	String	Error code
msg	String	Description
data	Object	Query result

**Table 3** data field description
Parameter	Type	Description
alarmId	String	Alarm ID
alarmName	String	Alarm name
alarmType	String	Alarm type. The value is alarm.
createAt	String	Time when an alarm is generated
detailedInformation	String	Alarm details
id	Number	Alarm ID
impact	String	Alarm impact description
ip	String	Device IP address
serialNumber	String	For MEF Edge alarms, the value is the device serial number. For MEF Center alarms, the value is an empty string.
perceivedSeverity	String	Severity: MINOR MAJOR CRITICAL
reason	String	Alarm cause
resource	String	Alarm source
suggestion	String	Alarm clearance suggestion

Parent topic: Alarm Event APIs