Retrieve Alarm
DescriptionThis operation retrieves an Alarm entity. Attribute selection is enabled for all first level attributes.
Request
URLURL
Path Parameters
Path Parameters
Identifier of the Alarm
id example
"Name:NOTIFICATION-gNodeB_gNodeB-service-mavenir_DUFunctionAffected$Source:INCHARGE-SA-PRES$"
Query Parameters
Query Parameters
Comma-separated properties to provide in response
fields example
"id"
Authentication
Response
Response BodyResponse Body
200 OK
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"ackState": "UNACKNOWLEDGED",
"ackSystemId": null,
"ackUserId": null,
"affectedService": null,
"alarmChangedTime": "2022-08-02T12:53:41Z",
"alarmClearedTime": null,
"alarmDetails": "Indicates that all of the system's IPv4 and IPv6 addresses not responding and the SNMPAgent is not responding as well. ",
"alarmEscalation": null,
"alarmRaisedTime": "2020-08-27T08:03:03Z",
"alarmReportingTime": "2022-10-25T08:09:12.161Z",
"alarmType": "Unresponsive",
"alarmedObject": {
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"href": "/tcsa/api/topology/v1/instances/AMPMNEWUS23000_PS_Router_267%24Router%24INCHARGE-SA-PRES2",
"id": "AMPMNEWUS23000_PS_Router_267$Router$INCHARGE-SA-PRES2"
},
"alarmedObjectType": "Router",
"clearSystemId": null,
"clearUserId": null,
"comment": [
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "Server: INCHARGE-SA-AGG2",
"systemId": null,
"time": "2022-08-02T12:53:30Z",
"userId": "DXA"
},
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "Server: INCHARGE-SA-AGG2",
"systemId": null,
"time": "2022-08-02T12:47:14Z",
"userId": "DXA"
},
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "INCHARGE-SA-AGG2: ICS initialization",
"systemId": null,
"time": "2022-08-02T12:45:56Z",
"userId": "SYSTEM"
},
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "Server: INCHARGE-SA-AGG2",
"systemId": null,
"time": "2022-01-31T13:22:13Z",
"userId": "DXA"
},
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "Server: INCHARGE-SA-AGG2",
"systemId": null,
"time": "2022-01-31T13:16:48Z",
"userId": "DXA"
},
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "INCHARGE-SA-AGG2: ICS initialization",
"systemId": null,
"time": "2022-01-31T13:14:32Z",
"userId": "SYSTEM"
},
{
"@baseType": "alarm",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"comment": "Server: INCHARGE-SA-AGG2",
"systemId": null,
"time": "2021-03-02T09:11:06Z",
"userId": "DXA"
}
],
"correlatedAlarm": [],
"crossedThresholdInformation": {},
"externalAlarmId": null,
"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-gNodeB_gNodeB-service-mavenir_DUFunctionAffected%24Source%3AINCHARGE-SA-PRES%24",
"id": "Name:NOTIFICATION-gNodeB_gNodeB-service-mavenir_DUFunctionAffected$Source:INCHARGE-SA-PRES$",
"isRootCause": false,
"parentAlarm": [
{
"@baseType": "alarm",
"@referredType": "null",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down%24Source%3AINCHARGE-SA-PRES2%24",
"id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down$Source:INCHARGE-SA-PRES2$",
"name": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down$Source:INCHARGE-SA-PRES2$"
},
{
"@baseType": "alarm",
"@referredType": "null",
"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
"@type": "notification",
"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down%24Source%3AINCHARGE-SA-PRES2%24",
"id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down$Source:INCHARGE-SA-PRES2$",
"name": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down$Source:INCHARGE-SA-PRES2$"
}
],
"perceivedSeverity": "UNKNOWN",
"place": [],
"plannedOutageIndicator": "OUT_OF_SERVICE",
"probableCause": null,
"proposedRepairedActions": null,
"reportingSystemId": null,
"serviceAffecting": null,
"sourceSystemId": "AMPMNEWUS23000",
"specificProblem": null,
"state": "ACTIVE"
}
The base type of this alarm.
A reference to the schema describing this alarm.
The type for this alarm.
Provides the Acknowledgement State of the alarm
Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm.
Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm.
Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time.
Indicates the time (as a date + time) at which the alarm is cleared at the source.
Contains further information on the alarm.
Indicates if this alarm has been escalated or not.
Indicates the time (as a date + time) at which the alarm occurred at its source.
Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS.
Categorize the alarm.
Identifies the managed object instance associated with the alarm.
The type (class) of the managed object associated with the event.
Provides the id of the system where the user who invoked the alarmCleared operation is located.
Provides the id of the user who invoked the alarmCleared operation
Identifies the details of the threshold that has been crossed.
An identifier of the alarm in the source system.
A reference to the alarm.
Identifier of the alarm, determined by the alarm owning system
Indicates whether the alarm is a root cause alarm..
Lists the possible severities that can be allocated to an Alarm.
Possible values are: CRITICAL , MAJOR , MINOR , NORMAL , UNKNOWN
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself
Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service).
Possible values are: PLANNED_MAINTENANCE , OUT_OF_SERVICE
Provides the probable cause of the alarm.
Indicates proposed repair actions, if known to the system emitting the alarm.
Reporting system identity.
Indicates whether the alarm affects service or not.
Source system identity.
Provides more specific information about the alarm.
Defines the alarm state during its life cycle
Errors
Bad Request
Unauthorized
Forbidden
Not Found
Method Not allowed
Conflict
Internal Server Error
