Alarm

Alarm
Alarm

The alarm data type encapsulates information about an alarm.

JSON Example
{
    "id": "string",
    "managedObjectId": "string",
    "vnfcInstanceIds": [
        "string"
    ],
    "rootCauseFaultyResource": {
        "faultyResource": {
            "vimConnectionId": "string",
            "resourceProviderId": "string",
            "resourceId": "string",
            "vimLevelResourceType": "string"
        },
        "faultyResourceType": "string"
    },
    "alarmRaisedTime": "string",
    "alarmChangedTime": "string",
    "alarmClearedTime": "string",
    "alarmAcknowledgedTime": "string",
    "ackState": "string",
    "perceivedSeverity": "string",
    "eventTime": "string",
    "eventType": "string",
    "faultType": "string",
    "probableCause": "string",
    "isRootCause": false,
    "correlatedAlarmIds": [
        "string"
    ],
    "faultDetails": [
        "string"
    ],
    "_links": {
        "self": {
            "href": "string"
        },
        "objectInstance": {
            "href": "string"
        }
    }
}
id
Required

id

managedObjectId
Required

managedObjectId

vnfcInstanceIds
Optional

Identifiers of the affected VNFC instances.

rootCauseFaultyResource
Optional

rootCauseFaultyResource

alarmRaisedTime
Required

alarmRaisedTime

alarmChangedTime
Optional

alarmChangedTime

alarmClearedTime
Optional

alarmClearedTime

alarmAcknowledgedTime
Optional

alarmAcknowledgedTime

string
ackState
Required

Acknowledgement state of the alarm. Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.

Possible values are : UNACKNOWLEDGED, ACKNOWLEDGED,
perceivedSeverity
Required

perceivedSeverity

eventTime
Required

eventTime

eventType
Required

eventType

string
faultType
Optional

Additional information to clarify the type of the fault.

string
probableCause
Required

Information about the probable cause of the fault.

boolean
isRootCause
Required

Attribute indicating if this fault is the root for other correlated alarms. If true, then the alarms listed in the attribute "correlatedAlarmId" are caused by this fault.

array of Identifier
correlatedAlarmIds
Optional

List of identifiers of other alarms correlated to this fault.

array of string
faultDetails
Optional

Provides additional information about the fault.

object
_links
Required

Links for this resource.