ClearAlarms

ClearAlarms
ClearAlarms

Task resource for clear alarms operation

JSON Example
{
    "id": "AS0UD4QBpi1WVs4LGnPr",
    "href": "/tcsa/api/tmf/v1/clearAlarms/AS0UD4QBpi1WVs4LGnPr",
    "alarmClearedTime": "2022-10-25T12:18:06.690858Z",
    "clearSystemId": "postman-api",
    "clearUserId": "admin",
    "state": "COMPLETED",
    "alarmPattern": [
        {
            "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down%24Source%3AINCHARGE-SA-PRES%24",
            "ackState": "UNACKNOWLEDGED",
            "ackSystemId": "string",
            "ackUserId": "string",
            "alarmChangedTime": "string",
            "alarmClearedTime": "string",
            "alarmDetails": "no description available",
            "alarmEscalation": false,
            "alarmRaisedTime": "string",
            "alarmReportingTime": "string",
            "alarmType": "Down",
            "alarmedObjectType": "KubernetesPod",
            "clearSystemId": "string",
            "clearUserId": "string",
            "externalAlarmId": "string",
            "isRootCause": true,
            "perceivedSeverity": "CRITICAL",
            "plannedOutageIndicator": "OUT_OF_SERVICE",
            "probableCause": "string",
            "proposedRepairedActions": "string",
            "reportingSystemId": "string",
            "serviceAffecting": false,
            "sourceSystemId": "INCHARGE-ESM, INCHARGE-SA-PRES",
            "specificProblem": "string",
            "state": "ACTIVE",
            "affectedService": [
                {
                    "id": "string",
                    "href": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string"
                }
            ],
            "alarmedObject": {
                "id": "KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b$KubernetesPod$INCHARGE-SA-PRES",
                "href": "/tcsa/api/topology/v1/instances/KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b%24KubernetesPod%24INCHARGE-SA-PRES",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            "comment": [
                {
                    "comment": "Testing Comments for openAPI spec",
                    "systemId": "postman-api",
                    "time": "string",
                    "userId": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string"
                }
            ],
            "correlatedAlarm": [
                {
                    "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
                    "name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification",
                    "@referredType": "string"
                }
            ],
            "crossedThresholdInformation": {
                "direction": "string",
                "granularity": "string",
                "indicatorName": "string",
                "indicatorUnit": "string",
                "observedValue": "string",
                "thresholdCrossingDescription": "string",
                "threshold": {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                },
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string"
            },
            "parentAlarm": [
                {
                    "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
                    "name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification",
                    "@referredType": "string"
                }
            ],
            "place": [
                {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "role": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                }
            ],
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification"
        }
    ],
    "clearedAlarm": [
        {
            "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Down%24Source%3AINCHARGE-SA-PRES%24",
            "ackState": "UNACKNOWLEDGED",
            "ackSystemId": "string",
            "ackUserId": "string",
            "alarmChangedTime": "string",
            "alarmClearedTime": "string",
            "alarmDetails": "no description available",
            "alarmEscalation": false,
            "alarmRaisedTime": "string",
            "alarmReportingTime": "string",
            "alarmType": "Down",
            "alarmedObjectType": "KubernetesPod",
            "clearSystemId": "string",
            "clearUserId": "string",
            "externalAlarmId": "string",
            "isRootCause": true,
            "name": "string",
            "perceivedSeverity": "CRITICAL",
            "plannedOutageIndicator": "OUT_OF_SERVICE",
            "probableCause": "string",
            "proposedRepairedActions": "string",
            "reportingSystemId": "string",
            "serviceAffecting": false,
            "sourceSystemId": "INCHARGE-ESM, INCHARGE-SA-PRES",
            "specificProblem": "string",
            "state": "ACTIVE",
            "affectedService": [
                {
                    "id": "string",
                    "href": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string"
                }
            ],
            "alarmedObject": {
                "id": "KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b$KubernetesPod$INCHARGE-SA-PRES",
                "href": "/tcsa/api/topology/v1/instances/KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b%24KubernetesPod%24INCHARGE-SA-PRES",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            "comment": [
                {
                    "comment": "Testing Comments for openAPI spec",
                    "systemId": "postman-api",
                    "time": "string",
                    "userId": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string"
                }
            ],
            "correlatedAlarm": [
                {
                    "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
                    "name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification",
                    "@referredType": "string"
                }
            ],
            "crossedThresholdInformation": {
                "direction": "string",
                "granularity": "string",
                "indicatorName": "string",
                "indicatorUnit": "string",
                "observedValue": "string",
                "thresholdCrossingDescription": "string",
                "threshold": {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                },
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string"
            },
            "parentAlarm": [
                {
                    "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
                    "name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification",
                    "@referredType": "string"
                }
            ],
            "place": [
                {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "role": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                }
            ],
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification",
            "@referredType": "string"
        }
    ],
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
string
id
Optional

The identifier of the task

string
href
Optional

A reference to the task

string As date-time As date-time
alarmClearedTime
Optional

Time of the alarm clearing

string
clearSystemId
Optional

Name of the clearing system

string
clearUserId
Optional

Name of the clearing user

string
state
Optional

Current state of the operation task

array of Alarm
alarmPattern
Optional

Alarm patterns to match target alarms. An alarm will match if an attribute in any of the patterns is equal to the corresponding attribute of the alarm. The attributes which are supported with matching are - id, alarmType, alarmedObjectType, perceivedSeverity, plannedOutageIndicator and state.

clearedAlarm
Optional

The successfully cleared alarms

string
@baseType
Optional

When sub-classing, this defines the super-class

string As uri As uri
@schemaLocation
Optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string
@type
Optional

When sub-classing, this defines the sub-class entity name