Querying Alarm Masking Rules

Function

This interface is used to query alarm masking rules.

Syntax

Operation type: GET

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

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/AlarmShield

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Alarm/AlarmShield",
    "@odata.id": "/redfish/v1/Systems/Alarm/AlarmShield",
    "@odata.type": "MindXEdgeAlarm.v1_0_0.MindXEdgeAlarm",
    "Id": "Alarm Shield",
    "Name": "Alarm Shield",
    "AlarmShieldMessages": [],
    "Increase": {
        "@odata.id": "/redfish/v1/Systems/Alarm/AlarmShield/Increase"
    },
    "Decrease": {
        "@odata.id": "/redfish/v1/Systems/Alarm/AlarmShield/Decrease"
    }
}

Response code: 200

Output Description

**Table 1** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of an alarm resource masking rule model.
@odata.id	Character string	Path to access an alarm resource masking rule.
@odata.type	Character string	Type of an alarm resource masking rule.
Id	Character string	ID of an alarm resource masking rule.
Name	Character string	Name of an alarm resource service.
AlarmShieldMessages	Array	Alarm masking information collection.
Increase	Object	Access path for creating alarm masking rules.
Decrease	Object	Access path for canceling alarm masking rules.

Parent topic: System Monitoring