Querying Event Details

Function

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

Syntax

Operation type: GET

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

Request message body: None

URL Parameters

**Table 1** Description
Parameter	Mandatory/Optional	Description	Value
id	Mandatory	Event 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/event?id=1430946159

Request message body: None

Response:

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "alarmId": "40eafda7-bce6-4850-9e35-949fc81b50bf",
        "alarmName": "ALARM DEFAULT NAME",
        "alarmType": "event",
        "createAt": "2023-09-27T16:01:25Z",
        "detailedInformation": "ALARM DEFAULT INFO",
        "id": 1430946159,
        "ip": "xx.xx.xx.xx",
        "impact": "ALARM DEFAULT Impact",
        "serialNumber": "xxxxxxxxxxxxxx",
        "perceivedSeverity": "MINOR",
        "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	Event ID
alarmName	String	Event name
alarmType	String	Event type. The value is event.
createAt	String	Time when an event is created
detailedInformation	String	Event details
id	Number	Event ID
ip	String	Device IP address
impact	String	Event impact description
serialNumber	String	For MEF Edge events, the value is the device serial number. For MEF Center events, the value is an empty string.
perceivedSeverity	String	Event level: OK: normal events MINOR MAJOR CRITICAL
reason	String	Event cause
resource	String	Event source
suggestion	String	Event handling suggestions

Parent topic: Alarm Event APIs