Alarm Management Open API

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

23 Minuten Lesedauer

Die offene Alarm Management API bietet Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Events“ [em_event] und „Warnung“ [em_alert].

Die Telekommunikations -Alarm Management Open API (sn_ind_tmf642) ist eine ServiceNow® Implementierung der TM Forum Open API-Spezifikation. Diese API basiert auf der TMF642 Alarm Management API REST-Spezifikation Release 20, April 2020.

Der aufrufende Benutzer muss Zugriff auf den Endpunkt sn_ind_tmf642.alarm_mgmt_integration haben.

Diese API wird im Namespace sn_ind_tmf642 bereitgestellt.

Die Open-API-Spezifikation des TM Forums erfordert eine synchrone Antwort für jede eingehende Anforderung. Wenden Sie Korrelation und Deduplizierung im Quell-Operative Support System (OSS) an, bevor Sie Nutzlasten an das System weiterleiten.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, Anforderungstextvalidierung, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter das Alarm Management Open API-Entwicklerleitfaden.

Die Konformität der offenen Alarm Management API wurde vom TM Forum zertifiziert.

TMF-Konformitätslogo

Alarm Management Open API – GET /sn_ind_tmf642/alarm_mgmt/alarm

Ruft eine Liste aller Alarmdatensätze aus den Tabellen „Ereignisse“ [em_event] und „Warnung“ [em_alert] ab.

URL-Format

Standard-URL: /api/sn_ind_tmf642/alarm_mgmt/alarm

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 2. Abfrageparameter
Name	Beschreibung
alarmAusgelöstZeit	Datum, an dem der Alarm ausgelöst wurde. In der Antwort werden nur Alarme zurückgegeben, deren Datum mit dem Wert dieses Parameters übereinstimmt. Datentyp: Zeichenfolge
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: alarmedObject alarmAusgelöstZeit alarmType CrossedThresholdInformation externe Alarm-ID id WahrscheinlichSchweregrad wahrscheinlicheUrsachen Quelle sourceSystemId Status type Standard: Alle Felder Datentyp: Zeichenfolge
id	Alarm-ID Nur Alarme mit einer ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Befindet sich im Feld Nachrichtenschlüssel in der Tabelle „Events“ [em_event]. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 1000 Maximum: 2000 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl
wahrscheinlicheUrsachen	Wahrscheinliche Ursache des Alarms. Nur Alarme mit einer wahrscheinlichen Ursache, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Status	Alarmstatus. Nur Alarme mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
sourceSystemId	Quellsystem-ID des Alarms. Nur Alarme mit einer Quellsystem-ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstextparameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Wenn beispielsweise `offset=2` und `limit=3`festgelegt ist, lautet der Wert der Kopfzeile Content-Range`items 3-5`.
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	In Antwort zurückgegebene Teilressource (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
betroffener Service	Liste der Objekte, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
betroffeneService.href	URL-Referenz mit Details zum betroffenen Service. Datentyp: Zeichenfolge
betroffeneService.id	Bezeichner des vom Alarm betroffenen Services. Dieser Wert ist dem betroffenen Configuration Item (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
alarmDetails	Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge
alarmedObject	Details des Alarmobjekts. `"alarmedObject": { "href": "String", "id": "String" }` Datentyp: Objekt
alarmedObject.id	Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge
alarmedObject.href	URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge
alarmedObjectType	Typ oder Klasse des Objekts, das dem Event zugeordnet ist. Datentyp: Zeichenfolge
alarmAusgelöstZeit	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
alarmReportingTime	Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich vom Wert alarmRaisedTime unterscheiden. Wenn beispielsweise ein Element Management System (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit der Speicherung in der EMS-Alarmliste. Datentyp: Zeichenfolge
alarmType	Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Datentyp: Objekt
CrossedThresholdInformation.Richtung	Schwellenwertüberschreitungsrichtung. Mögliche Werte: NACH OBEN NACH UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator auf Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorName	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, die dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertId	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm ausgelöst hat. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externe Alarm-ID	Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
href	URL der -Ressource. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System, um die Alarmnutzlast als Event zu identifizieren und zu verarbeiten. Datentyp : Zeichenfolge
WahrscheinlichSchweregrad	Alarmschweregrad. Mögliche Werte: LÖSCHEN KRITISCH GRÜNDLICH GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
geplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
wahrscheinlicheUrsachen	Wahrscheinlichste Situation, um den Alarm auszulösen. Verwenden Sie diese Option mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn für das System verfügbar, stellt eine Reparaturaktion bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAuswirkung	Kennzeichnung, die angibt, ob sich der Alarm auf den -Service auswirkt. Gültige Werte: true: Alarm wirkt sich auf Serviceleistung oder -verfügbarkeit aus. false: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie diese Option mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`gesetzt. Wenn der Status `Bereit`lautet, wird in der Warnungstabelle [em_alert] eine Warnung erstellt, und der Status wird in `Verarbeitet`geändert. Wenn der Status `Verarbeitet`, `Ignoriert`oder `Fehler` lautet, wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Alarme abgerufen.

curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

[
   {
      "externalAlarmId": "2212331",
      "alarmType": "QualityOfServiceAlarm23",
      "perceivedSeverity": "MAJOR",
      "probableCause": "ProbB",
      "sourceSystemId": "checkSB",
      "alarmedObject": {
         "id": "vManage_000000",
         "href": " http://api/alarmedobject/000000"
      },
      "crossedThresholdInformation": {
         "direction": "111",
         "granularity": "1234",
         "indicatorName": "sdfgds",
         "indicatorUnit": "asdfdsaf",
         "observedValue": "adsfds",
         "thresholdId": "12fasdfasdfasd",
         "thresholdCrossingDescription": "S23rtring",
         "thresholdRef": "asdfasf"
      },
      "type": "QualityOfServiceAlarm",
      "ackState": "acknowledged",
      "specificProblem": "Inbound Traffic threshold crossed",
      "alarmedObjectType": "ROUTER",
      "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
      "state": "processed",
      "alarmChangedTime": "2017-08-15T07:04:15.666Z",
      "proposedRepairActions": "Switch in standby equipment",
      "alarmReportingTime": "2017-06-15T07:04:15.666Z",
      "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
      "plannedOutageIndication": "IN_SERVICE",
      "serviceAffecting": true,
      "affectedService": [
         {
            "id": "SD WAN Enterprise Solutions",
            "href": "http://api/service/vlan_dot0_dot0"
         },
         {
            "id": "Santa Clara SD WAN Application Service",
            "href": "http://api/service/vlan_dot0_dot0"
         }
      ],
      "source": "Alarm Management Open API",
      "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
      "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
   },
   {
      "externalAlarmId": "2212331",
      "alarmType": "QualityOfServiceAlarm23",
      "perceivedSeverity": "MAJOR",
      "probableCause": "ProbB",
      "sourceSystemId": "checkSB",
      "alarmedObject": {
         "id": "vManage_000000",
         "href": " http://api/alarmedobject/000000"
      },
      "crossedThresholdInformation": {
         "direction": "111",
         "granularity": "1234",
         "indicatorName": "sdfgds",
         "indicatorUnit": "asdfdsaf",
         "observedValue": "adsfds",
         "thresholdId": "12fasdfasdfasd",
         "thresholdCrossingDescription": "S23rtring",
         "thresholdRef": "asdfasf"
      },
      "type": "QualityOfServiceAlarm",
      "ackState": "acknowledged",
      "specificProblem": "Inbound Traffic threshold crossed",
      "alarmedObjectType": "ROUTER",
      "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
      "state": "processed",
      "alarmChangedTime": "2017-08-15T07:04:15.666Z",
      "proposedRepairActions": "Switch in standby equipment",
      "alarmReportingTime": "2017-06-15T07:04:15.666Z",
      "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
      "plannedOutageIndication": "IN_SERVICE",
      "serviceAffecting": true,
      "affectedService": [
         {
            "id": "SD WAN Enterprise Solutions",
            "href": "http://api/service/vlan_dot0_dot0"
         },
         {
            "id": "Santa Clara SD WAN Application Service",
            "href": "http://api/service/vlan_dot0_dot0"
         }
      ],
      "source": "Alarm Management Open API",
      "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001c84aa29078d10f87759e2f69e4cfa_2212331",
      "id": "001c84aa29078d10f87759e2f69e4cfa_2212331"
   }
]

Alarm Management Open API – GET /sn_ind_tmf642/alarm_mgmt/alarm/{id}

Ruft einen angegebenen Alarmdatensatz aus der Tabelle „Ereignisse“ [em_event] oder „Warnung“ [em_alert] ab.

URL-Format

Standard-URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
id	Eindeutiger Identifier des abzurufenden Datensatzes. Befindet sich im Feld Nachrichtenschlüssel in der Tabelle „Events“ [em_event]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: alarmedObject alarmAusgelöstZeit alarmType CrossedThresholdInformation externe Alarm-ID id WahrscheinlichSchweregrad wahrscheinlicheUrsachen Quelle sourceSystemId Status type Standardwert: Alle Felder Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstextparameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung wurde aus einem oder mehreren der folgenden Gründe erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein Datensatz, der der angegebenen ID zugeordnet ist, wurde in der Tabelle „Event“ [em_event] oder „Warnung“ [em_alert] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
betroffener Service	Liste der Objekte, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
betroffeneService.href	URL-Referenz mit Details zum betroffenen Service. Datentyp: Zeichenfolge
betroffeneService.id	Bezeichner des vom Alarm betroffenen Services. Dieser Wert ist dem betroffenen Configuration Item (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
alarmDetails	Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge
alarmedObject	Details des Alarmobjekts. Datentyp: Objekt `"alarmedObject": { "href": "String", "id": "String" }`
alarmedObject.id	Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge
alarmedObject.href	URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge
alarmedObjectType	Typ oder Klasse des Objekts, das dem Event zugeordnet ist. Datentyp: Zeichenfolge
alarmAusgelöstZeit	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
alarmReportingTime	Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich vom Wert alarmRaisedTime unterscheiden. Wenn beispielsweise ein Element Management System (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit der Speicherung in der EMS-Alarmliste. Datentyp: Zeichenfolge
alarmType	Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Datentyp: Objekt
CrossedThresholdInformation.Richtung	Schwellenwertüberschreitungsrichtung. Mögliche Werte: NACH OBEN NACH UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator auf Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorName	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, die dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertId	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm ausgelöst hat. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externe Alarm-ID	Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
href	URL von der Ressource. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System, um die Alarmnutzlast als Event zu identifizieren und zu verarbeiten. Datentyp: Zeichenfolge
WahrscheinlichSchweregrad	Alarmschweregrad. Mögliche Werte: LÖSCHEN KRITISCH GRÜNDLICH GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
geplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
wahrscheinlicheUrsachen	Wahrscheinlichste Situation, um den Alarm auszulösen. Verwenden Sie diese Option mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn für das System verfügbar, stellt eine Reparaturaktion bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAuswirkung	Kennzeichnung, die angibt, ob sich der Alarm auf den -Service auswirkt. Gültige Werte: true: Alarm wirkt sich auf Serviceleistung oder -verfügbarkeit aus. false: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie diese Option mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`gesetzt. Wenn der Status `Bereit`lautet, wird in der Warnungstabelle [em_alert] eine Warnung erstellt, und der Status wird in `Verarbeitet`geändert. Wenn der Status `Verarbeitet`, `Ignoriert`oder `Fehler` lautet, wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Alarm abgerufen.

curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
   "externalAlarmId": "2212331",
   "alarmType": "QualityOfServiceAlarm23",
   "perceivedSeverity": "MAJOR",
   "probableCause": "ProbB",
   "sourceSystemId": "checkSB",
   "alarmedObject": {
      "id": "vManage_000000",
      "href": " http://api/alarmedobject/000000"
   },
   "crossedThresholdInformation": {
      "direction": "111",
      "granularity": "1234",
      "indicatorName": "ind_name",
      "indicatorUnit": "ind_unit",
      "observedValue": "232",
      "thresholdId": "200",
      "thresholdCrossingDescription": "sample_description",
      "thresholdRef": "sample_ref"
   },
   "type": "QualityOfServiceAlarm",
   "ackState": "acknowledged",
   "specificProblem": "Inbound Traffic threshold crossed",
   "alarmedObjectType": "ROUTER",
   "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
   "state": "processed",
   "alarmChangedTime": "2017-08-15T07:04:15.666Z",
   "proposedRepairActions": "Switch in standby equipment",
   "alarmReportingTime": "2017-06-15T07:04:15.666Z",
   "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
   "plannedOutageIndication": "IN_SERVICE",
   "serviceAffecting": true,
   "affectedService": [
      {
         "id": "SD WAN Enterprise Solutions",
         "href": "http://api/service/vlan_dot0_dot0"
      },
      {
         "id": "Santa Clara SD WAN Application Service",
         "href": "http://api/service/vlan_dot0_dot0"
      }
   ],
   "source": "Alarm Management Open API",
   "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
   "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
}

Alarm Management Open API – PATCH /sn_ind_tmf642/alarm_mgmt/alarm/{id}

Aktualisiert einen angegebenen Alarm und alle zugehörigen Warnungen.

Dieser Endpunkt schreibt den Antworttext in das Feld Zusätzliche Informationen des Event-Datensatzes in der Event-Tabelle [em_event].

URL-Format

Standard-URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
id	Eindeutiger Identifier des zu aktualisierenden Datensatzes. Befindet sich im Feld Nachrichtenschlüssel in der Tabelle „Events“ [em_event]. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (JSON)
Name	Beschreibung
betroffener Service	Liste der Objekte, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
betroffeneService.href	URL-Referenz mit Details zum betroffenen Service. Datentyp: Zeichenfolge
betroffeneService.id	Erforderlich. Bezeichner des vom Alarm betroffenen Services. Dieser Wert ist dem betroffenen Configuration Item (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
alarmChangedTime	Gibt das letzte Datum und die letzte Uhrzeit an, zu der sich der Alarm im Besitzersystem des Alarms geändert hat. Bei jeder Änderung des Alarms wird dieser Wert aktualisiert, unabhängig davon, ob er von der alarmierten Ressource stammt oder durch eine Änderung des Clients ausgelöst wird. Datentyp: Zeichenfolge
alarmDetails	Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge
alarmEskalation	Kennzeichnung, die eine Eskalation des Alarmschweregrads angibt. Gültige Werte: true: Es liegt eine Eskalation des Alarmschweregrads vor. false: Der Schweregrad des Alarms ist gleich oder niedriger. Standardwert: false Datentyp: Boolesch
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Datentyp: Objekt
CrossedThresholdInformation.Richtung	Schwellenwertüberschreitungsrichtung. Mögliche Werte: NACH OBEN NACH UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator auf Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorName	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, die dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertId	Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm ausgelöst hat. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
href	URL-Verweis auf den Alarm. Datentyp: Zeichenfolge
WahrscheinlichSchweregrad	Erforderlich. Alarmschweregrad. Mögliche Werte: LÖSCHEN KRITISCH GRÜNDLICH GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
geplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
wahrscheinlicheUrsachen	Erforderlich. Wahrscheinlichste Situation, um den Alarm auszulösen. Verwenden Sie diese Option mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn für das System verfügbar, stellt eine Reparaturaktion bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAuswirkung	Kennzeichnung, die angibt, ob sich der Alarm auf den -Service auswirkt. Gültige Werte: true: Alarm wirkt sich auf Serviceleistung oder -verfügbarkeit aus. false: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie diese Option mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültige Nutzlast. Erforderliche Alarm-ID fehlt. Ungültige Nutzlast. Pflichtfeld fehlt:<field name> . Ungültige Nutzlast. Erforderliches Objekt fehlt. Event nicht erstellt, fehlgeschlagen. Event kann nicht gelöscht werden. Ereignis kann nicht aktualisiert werden. Das Ereignis ist nicht vorhanden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
alarmChangedTime	Datum und Uhrzeit, zu der sich der Alarm in GMT auf dem Alarmbesitzer-System geändert hat. Dieser Wert liegt im GlideDateTime-Format vor und befindet sich im Feld Time of event eines Datensatzes in der Tabelle „Events“ [em_events]. Dieser Wert wird aktualisiert, wenn Änderungen am Alarm von der alarmierten Ressource auftreten oder eine Änderung von einem Client-Update den Alarm auslöst. Dieser Wert ist in der Antwort erforderlich. Datentyp: Zeichenfolge
href	URL-Verweis auf den Alarm. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner des Alarms. Wert, der vom System bestimmt wird, das den Alarm besitzt. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird der Schweregrad auf GERINGFÜGIG reduziert.

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
     \"href\":\"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00\",
     \"externalAlarmId\":\"<external-alarm-id>\",
     \"alarmType\":\"QualityOfServiceAlarm\",
     \"type\":\"QualityOfServiceAlarm\",
     \"ackState\":\"acknowledged\",
     \"perceivedSeverity\":\"MINOR\",
     \"probableCause\":\"Threshold crossed\",
     \"specificProblem\":\"Inbound Traffic threshold crossed\",
     \"alarmedObjectType\":\"ROUTER\",
     \"alarmedObject\":{
        \"id\":\"vManage_000000\",
        \"href\":\" http://api/alarmedobject/000000\"
     },
     \"sourceSystemId\":\"SOURCE_SYSTEM_vManage_00000_000_00\",
     \"alarmDetails\":\"Software Failure on SD-WAN Controller vManage_000000\",
     \"alarmEscalation\": false,
     \"state\":\"RAISED\",
     \"alarmChangedTime\":\"2017-08-15T07:04:15.666Z\",
     \"proposedRepairActions\":\"Switch in standby equipment\",
     \"alarmReportingTime\":\"2017-06-15T07:04:15.666Z\",
     \"alarmRaisedTime\":\"2020-09-15T07:04:15.666Z\",
     \"plannedOutageIndication\":\"IN_SERVICE\",
     \"serviceAffecting\":true,
     \"affectedService\":[
        {
           \"id\":\"SD WAN Enterprise Solutions\",
           \"href\":\"http://api/service/vlan_dot0_dot0\"
        },
        {
           \"id\":\"Santa Clara SD WAN Application Service\",
           \"href\":\"http://api/service/vlan_dot0_dot0\"
        }
     ] 
 }" \
--user 'user:'password'

Antworttext.

{
  "result": {
    "alarmChangedTime": "2017-08-15T07:04:15.666Z",
    "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
  }
}

Alarm Management Open API – POST /sn_ind_tmf642/alarm_mgmt/alarm

Erstellt einen Alarmdatensatz in der Tabelle „Ereignisse“ [em_event].

Wenn der Alarmdatensatz erstellt wird, wird im Feld Message key eine ID für den Alarm hinzugefügt.

Ein Warnungsdatensatz kann auch basierend auf Warnungsverwaltungsregeln erstellt werden.

Dieser Endpunkt schreibt den Antworttext in das Feld Zusätzliche Informationen des Event-Datensatzes in der Event-Tabelle [em_event].

URL-Format

Standard-URL: /api/sn_ind_tmf642/alarm_mgmt/alarm

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (JSON)
Name	Beschreibung
betroffener Service	Liste der Objekte, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
betroffeneService.href	URL-Referenz mit Details zum betroffenen Service. Datentyp: Zeichenfolge
betroffeneService.id	Erforderlich. Bezeichner des vom Alarm betroffenen Services. Dieser Wert ist dem betroffenen Configuration Item (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
alarmDetails	Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge
alarmedObject	Erforderlich. Details des Alarmobjekts. `"alarmedObject": { "href": "String", "id": "String" }` Datentyp: Objekt
alarmedObject.id	Erforderlich. Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge
alarmedObject.href	URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge
alarmedObjectType	Typ oder Klasse des Objekts, das dem Event zugeordnet ist. Datentyp: Zeichenfolge
alarmAusgelöstZeit	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
alarmReportingTime	Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich vom Wert alarmRaisedTime unterscheiden. Wenn beispielsweise ein Element Management System (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit der Speicherung in der EMS-Alarmliste. Datentyp: Zeichenfolge
alarmType	Erforderlich. Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Datentyp: Objekt
CrossedThresholdInformation.Richtung	Schwellenwertüberschreitungsrichtung. Mögliche Werte: NACH OBEN NACH UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator auf Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorName	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, die dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertId	Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm ausgelöst hat. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externe Alarm-ID	Erforderlich. Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System, um die Alarmnutzlast als Event zu identifizieren und zu verarbeiten. Dieser Wert muss leer sein, wenn er in der Nutzlast verwendet wird. Das System generiert diese eindeutige ID für das Event und sendet sie als Teil der Payload der Antwort. Datentyp: Zeichenfolge
WahrscheinlichSchweregrad	Erforderlich. Alarmschweregrad. Mögliche Werte: LÖSCHEN KRITISCH GRÜNDLICH GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
geplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
wahrscheinlicheUrsachen	Erforderlich. Wahrscheinlichste Situation, um den Alarm auszulösen. Verwenden Sie diese Option mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn für das System verfügbar, stellt eine Reparaturaktion bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAuswirkung	Kennzeichnung, die angibt, ob sich der Alarm auf den -Service auswirkt. Gültige Werte: true: Alarm wirkt sich auf Serviceleistung oder -verfügbarkeit aus. false: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Erforderlich. Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie diese Option mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`gesetzt. Wenn der Status `Bereit`lautet, wird in der Warnungstabelle [em_alert] eine Warnung erstellt, und der Status wird in `Verarbeitet`geändert. Wenn der Status `Verarbeitet`, `Ignoriert`oder `Fehler` lautet, wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge

Header

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültige Nutzlast. Erforderliche Alarm-ID fehlt. Ungültige Nutzlast. Pflichtfeld fehlt:<field name> . Ungültige Nutzlast. Erforderliches Objekt fehlt. Event nicht erstellt, fehlgeschlagen. Event kann nicht gelöscht werden. Ereignis kann nicht aktualisiert werden. Das Ereignis ist nicht vorhanden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
betroffener Service	Liste der Objekte, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
betroffeneService.href	URL-Referenz mit Details zum betroffenen Service. Datentyp: Zeichenfolge
betroffeneService.id	Bezeichner des vom Alarm betroffenen Services. Dieser Wert ist dem betroffenen Configuration Item (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
alarmDetails	Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge
alarmedObject	Details des Alarmobjekts. `"alarmedObject": { "href": "String", "id": "String" }` Datentyp: Objekt
alarmedObject.id	Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge
alarmedObject.href	URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge
alarmedObjectType	Typ oder Klasse des Objekts, das dem Event zugeordnet ist. Datentyp: Zeichenfolge
alarmAusgelöstZeit	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
alarmReportingTime	Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich vom Wert alarmRaisedTime unterscheiden. Wenn beispielsweise ein Element Management System (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit der Speicherung in der EMS-Alarmliste. Datentyp: Zeichenfolge
alarmType	Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Datentyp: Objekt
CrossedThresholdInformation.Richtung	Schwellenwertüberschreitungsrichtung. Mögliche Werte: NACH OBEN NACH UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator auf Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorName	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, die dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertId	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm ausgelöst hat. Datentyp: Zeichenfolge
gekreuzteSchwellenwertInformation.SchwellenwertRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externe Alarm-ID	Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
href	URL der Ressource. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System, um die Alarmnutzlast als Event zu identifizieren und zu verarbeiten. Datentyp: Zeichenfolge
WahrscheinlichSchweregrad	Alarmschweregrad. Mögliche Werte: LÖSCHEN KRITISCH GRÜNDLICH GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
geplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
wahrscheinlicheUrsachen	Wahrscheinlichste Situation, um den Alarm auszulösen. Verwenden Sie diese Option mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn für das System verfügbar, stellt eine Reparaturaktion bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAuswirkung	Kennzeichnung, die angibt, ob sich der Alarm auf den -Service auswirkt. Gültige Werte: true: Alarm wirkt sich auf Serviceleistung oder -verfügbarkeit aus. false: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie diese Option mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`gesetzt. Wenn der Status `Bereit`lautet, wird in der Warnungstabelle [em_alert] eine Warnung erstellt, und der Status wird in `Verarbeitet`geändert. Wenn der Status `Verarbeitet`, `Ignoriert`oder `Fehler` lautet, wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Alarm erstellt.

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
     "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
     "externalAlarmId":"<external-alarm-id>",
     "alarmType":"QualityOfServiceAlarm",
     "type":"QualityOfServiceAlarm",
     "ackState":"acknowledged",
     "perceivedSeverity":"CRITICAL",
     "probableCause":"Threshold crossed",
     "specificProblem":"Inbound Traffic threshold crossed",
     "alarmedObjectType":"ROUTER",
     "alarmedObject":{
        "id":"vManage_000000",
        "href":" http://api/alarmedobject/000000"
     },
     "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
     "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
     "state":"RAISED",
     "alarmChangedTime":"2017-08-15T07:04:15.666Z",
     "proposedRepairActions":"Switch in standby equipment",
     "alarmReportingTime":"2017-06-15T07:04:15.666Z",
     "alarmRaisedTime":"2020-09-15T07:04:15.666Z",
     "plannedOutageIndication":"IN_SERVICE",
     "serviceAffecting":true,
     "affectedService":[
        {
           "id":"SD WAN Enterprise Solutions",
           "href":"http://api/service/vlan_dot0_dot0"
        },
        {
           "id":"Santa Clara SD WAN Application Service",
           "href":"http://api/service/vlan_dot0_dot0"
        }
     ] 
 }" \
--user 'user':'password'

Antworttext.

{
     "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
     "externalAlarmId":"<external-alarm-id>",
     "alarmType":"QualityOfServiceAlarm",
     "type":"QualityOfServiceAlarm",
     "ackState":"acknowledged",
     "perceivedSeverity":"CRITICAL",
     "probableCause":"Threshold crossed",
     "specificProblem":"Inbound Traffic threshold crossed",
     "alarmedObjectType":"ROUTER",
     "alarmedObject":{
        "id":"vManage_000000",
        "href":" http://api/alarmedobject/000000"
     },
     "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
     "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
     "state":"RAISED",
     "alarmChangedTime":"2017-08-15T07:04:15.666Z",
     "proposedRepairActions":"Switch in standby equipment",
     "alarmReportingTime":"2017-06-15T07:04:15.666Z",
     "alarmRaisedTime":"2020-09-15T07:04:15.666Z",
     "plannedOutageIndication":"IN_SERVICE",
     "serviceAffecting":true,
     "affectedService":[
        {
           "id":"SD WAN Enterprise Solutions",
           "href":"http://api/service/vlan_dot0_dot0"
        },
        {
           "id":"Santa Clara SD WAN Application Service",
           "href":"http://api/service/vlan_dot0_dot0"
        }
     ] 
 }

Alarm Management Open API – POST /sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

Löscht einen angegebenen Alarm und schließt alle zugehörigen Warnungen.

URL-Format

Standard-URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter
Name	Beschreibung
id	Eindeutiger Bezeichner des zu löschenden Alarms. Befindet sich im Feld Nachrichtenschlüssel in der Tabelle „Events“ [em_events]. Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 27. Anforderungstextparameter (JSON)
Name	Beschreibung
alarmGelöschtZeit	Datum und Uhrzeit, zu der der Alarm an der Quelle gelöscht wird. Dieser Wert befindet sich im Feld Time of event des Datensatzes in der Tabelle „Ereignisse“ [em_events]. Datentyp: Zeichenfolge
clearSystemId	Erforderlich. Name der Instanz, von der aus der Vorgang alarmCleared aufgerufen wurde. Datentyp: Zeichenfolge
clearUserId	Erforderlich. Eindeutige ID des Benutzers, der den Vorgang alarmCleared aufgerufen hat. Dieser Wert befindet sich im Feld Source des Datensatzes in der Tabelle „Ereignisse“ [em_events]. Datentyp: Zeichenfolge

Header

Tabelle : 28. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 29. Antwortkopfzeilen
Name	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültige Nutzlast. Erforderliche Alarm-ID fehlt. Ungültige Nutzlast. Pflichtfeld fehlt:<field name> . Ungültige Nutzlast. Erforderliches Objekt fehlt. Event nicht erstellt, fehlgeschlagen. Event kann nicht gelöscht werden. Ereignis kann nicht aktualisiert werden. Das Ereignis ist nicht vorhanden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
alarmGelöschtZeit	Datum und Uhrzeit, zu der der Alarm an der Quelle gelöscht wird. Dieser Wert befindet sich im Feld Time of event des Datensatzes in der Tabelle „Ereignisse“ [em_events]. Datentyp: Zeichenfolge
clearSystemId	Name der Instanz, von der aus der Vorgang alarmCleared aufgerufen wurde. Datentyp: Zeichenfolge
clearUserId	Eindeutige ID des Benutzers, der den Vorgang alarmCleared aufgerufen hat. Dieser Wert befindet sich im Feld Source des Datensatzes in der Tabelle „Ereignisse“ [em_events]. Datentyp: Zeichenfolge
href	URL des Alarms. Datentyp: Zeichenfolge
id	Eindeutige ID im Feld Message key eines Datensatzes in der Tabelle „Ereignisse“ [em_events]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Alarm gelöscht.

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"alarmClearedTime\": \"2017-08-15 06:04:15\",
  \"clearSystemId\": \"<source_instance_name>\",
  \"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\" 
}" \
--user 'user':'password'

Antworttext.

{
  "result": {
    "alarmClearedTime": "2017-08-15 06:04:15",
    "clearSystemId": "<source_instance_name>",
    "clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00",
    "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
  }
}