Querying Alarm Resource Services

Function

This interface is used to query alarm resource services.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/Alarm/AlarmInfo

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/Alarm/AlarmInfo

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Alarm/AlarmInfo",
    "@odata.id": "/redfish/v1/Systems/Alarm/AlarmInfo",
    "@odata.type": "MindXEdgeAlarm.v1_0_0.MindXEdgeAlarm",
    "Id" : "Alarm Info",
    "Name": "Alarm Info",
    "AlarMessages": [
        {
            "AlarmId": "00160000",
            "AlarmName": "directory space full",
            "AlarmInstance": "MEM OR STORAGE",
            "Timestamp": "2022-12-25 00:07:31",
            "PerceivedSeverity": "2"
        }
    ]
}

Response code: 200

Output Description

**Table 1** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of an alarm resource service model.
@odata.id	Character string	Path to access an alarm resource service.
@odata.type	Character string	Type of an alarm resource service.
Name	Character string	Name of an alarm resource service.
Id	Character string	ID of the alarm resource service.
AlarMessages	Array	Alarm information collection.
AlarmId	Character string	Alarm ID.
AlarmName	Character string	Alarm name.
AlarmInstance	Character string	Alarm object, that is, a faulty component.
Timestamp	Character string	Time when an alarm is generated.
PerceivedSeverity	Character string	Severity. 0: critical 1: major 2: minor

Parent topic: System Monitoring