Querying Alarm Resource Information

Function

This interface is used to query alarm resource information.

Syntax

Operation type: GET

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

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

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Alarm",
    "@odata.id": "/redfish/v1/Systems/Alarm",
    "@odata.type": "MindXEdgeAlarm.v1_0_0.MindXEdgeAlarm",
    "Id": "Alarm",
    "Name": "Alarm",
    "AlarmInfo": {
        "@odata.id": "/redfish/v1/Systems/Alarm/AlarmInfo"
    },
    "AlarmShield": {
        "@odata.id": "/redfish/v1/Systems/Alarm/AlarmShield"
    }
}

Response code: 200

Output Description

**Table 1** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of an alarm resource model.
@odata.id	Character string	Path to access an alarm resource.
@odata.type	Character string	Alarm resource type.
Id	Character string	Alarm resource ID.
Name	Character string	Alarm resource name.
AlarmInfo	Object	Alarm resource service information.
AlarmShield	Object	Masking rule for alarm resources.

Parent topic: System Monitoring