Offene API für Alarmmanagement

Freigeben Version: Xanadu

Aktualisiert 1. August 2024

23 Minuten Lesedauer

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

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

Der aufrufende Benutzer muss auf den Endpunkt sn_ind_tmf642.alarm_mgmt_integration zugreifen.

Diese API wird im Namespace sn_ind_tmf642 bereitgestellt.

Die Spezifikation „TM Forum Open API“ erfordert für jede eingehende Anforderung eine synchrone Antwort. Wenden Sie Korrelation und Deduplizierung im Quellsystem für operative Unterstützung an, bevor Sie Nutzlasten an das System weiterleiten.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unter im Entwicklerhandbuch für die Alarm Management Open API.

Die Alarm Management Open API ist vom TM Forum zertifiziert.

TMF-Konformitätslogo

Offene Alarm-Management-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
AlarmRaistTime	Datum, an dem der Alarm ausgelöst wurde. In der Antwort werden nur Alarme mit einem Datum zurückgegeben, das dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: AlarmedObject AlarmRaistTime Alarmtyp CrossedThresholdInformation externeAlarmId id resolvedSeverity probableUrsache Quelle sourceSystemId Staat type Standard: Alle Felder Datentyp: Zeichenfolge
id	Alarm-ID Nur Alarme mit einer ID, die dem Wert dieses Parameters entsprechen, werden in der Antwort zurückgegeben. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse“ [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, ab 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
probableUrsache	Wahrscheinliche Ursache des Alarms. Nur Alarme mit einer wahrscheinlichen Ursache, die dem Wert dieses Parameters entsprechen, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Staat	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. In der Antwort werden nur Alarme mit einer Quellsystem-ID zurückgegeben, die dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge

Tabelle : 3. Parameter des Anforderungstexts (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. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	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	Für paginierte 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	Teilressource, die als Antwort zurückgegeben wird (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
BetroffenerService	Liste von Objekten, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
impactedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Bezeichner des vom Alarm betroffenen Services. Dieser Wert wird 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 Ereignis zugeordnet ist. Datentyp: Zeichenfolge
AlarmRaistTime	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
AlarmReportingTime	Datum und Uhrzeit, zu der das ESS seinen Alarm meldet. Dieser Wert kann vom Wert alarmRaisedTime abweichen. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit des Speichers in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	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
überschrittSchwellenwertInformationen.Richtung	Richtung der Schwellenwertüberschreitung. Mögliche Werte: UP UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator für das Überschreiten des Schwellenwerts ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
ÜberschrittSchwellenwertInformationen.Indikatorname	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschritten hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdId	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externeAlarmId	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 zum Identifizieren und Verarbeiten der Alarmnutzlast als Ereignis. Datentyp : Zeichenfolge
resolvedSeverity	Alarmschweregrad. Mögliche Werte: CLEAR KRITISCH GRÜNDLICH Geringfügig WARNUNG Datentyp: Zeichenfolge
GeplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm im Status „Geplanter Ausfall“ befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
probableUrsache	Wahrscheinlichste Situation, die den Alarm auslöst. Verwenden Sie mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn dies im System verfügbar ist, stellt eine Reparaturaktion für bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAffected	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt Gültige Werte: wahr: Alarm wirkt sich auf Serviceleistung oder Verfügbarkeit aus. „falsch“: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
SpecificProblem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Staat	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`festgelegt. Wenn der Status `Bereit`ist, wird in der Warnungstabelle [em_alert] eine Warnung erstellt und der Status ändert sich in `Verarbeitet`. Bei Status „ `Verarbeitet`“, `„Ignoriert“`oder „ `Fehler` “ 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"
   }
]

Offene Alarm-Management-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. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse“ [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 AlarmRaistTime Alarmtyp CrossedThresholdInformation externeAlarmId id resolvedSeverity probableUrsache Quelle sourceSystemId Staat type Standardwert: Alle Felder Datentyp: Zeichenfolge

Tabelle : 9. Parameter des Anforderungstexts (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. Aus einem oder mehreren der folgenden Gründe wurde ein ungültiger Anforderungstyp oder eine falsch formatierte Anforderung erkannt. Ungültiger Pfadparameter. Ungültiger URI.
404	Datensatz nicht gefunden Ein Datensatz, der der angegebenen ID zugeordnet ist, wurde in der Tabelle „Ereignis“ [em_event] oder „Warnung“ [em_alert] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
BetroffenerService	Liste von Objekten, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
impactedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Bezeichner des vom Alarm betroffenen Services. Dieser Wert wird 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 Ereignis zugeordnet ist. Datentyp: Zeichenfolge
AlarmRaistTime	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
AlarmReportingTime	Datum und Uhrzeit, zu der das ESS seinen Alarm meldet. Dieser Wert kann vom Wert alarmRaisedTime abweichen. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit des Speichers in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	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
überschrittSchwellenwertInformationen.Richtung	Richtung der Schwellenwertüberschreitung. Mögliche Werte: UP UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator für das Überschreiten des Schwellenwerts ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
ÜberschrittSchwellenwertInformationen.Indikatorname	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschritten hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdId	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externeAlarmId	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 zum Identifizieren und Verarbeiten der Alarmnutzlast als Ereignis. Datentyp: Zeichenfolge
resolvedSeverity	Alarmschweregrad. Mögliche Werte: CLEAR KRITISCH GRÜNDLICH Geringfügig WARNUNG Datentyp: Zeichenfolge
GeplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm im Status „Geplanter Ausfall“ befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
probableUrsache	Wahrscheinlichste Situation, die den Alarm auslöst. Verwenden Sie mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn dies im System verfügbar ist, stellt eine Reparaturaktion für bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAffected	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt Gültige Werte: wahr: Alarm wirkt sich auf Serviceleistung oder Verfügbarkeit aus. „falsch“: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
SpecificProblem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Staat	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`festgelegt. Wenn der Status `Bereit`ist, wird in der Warnungstabelle [em_alert] eine Warnung erstellt und der Status ändert sich in `Verarbeitet`. Bei Status „ `Verarbeitet`“, `„Ignoriert“`oder „ `Fehler` “ 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"
}

Offene Alarmmanagement-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 Ereignisdatensatzes in der Tabelle „Ereignisse“ [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. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse“ [em_event]. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
BetroffenerService	Liste von Objekten, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
impactedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Erforderlich. Bezeichner des vom Alarm betroffenen Services. Dieser Wert wird dem betroffenen Configuration Item (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
AlarmChangedTime	Gibt das letzte Datum und die letzte Uhrzeit an, zu der der Alarm im System, für das der Alarm verantwortlich ist, geändert wurde. Jede Änderung des Alarms aktualisiert diesen Wert, unabhängig davon, ob er von der Ressource des Alarms 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 anzeigt. Gültige Werte: wahr: Es liegt eine Eskalation im Alarmschweregrad vor. „falsch“: Der Alarmschweregrad 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
überschrittSchwellenwertInformationen.Richtung	Richtung der Schwellenwertüberschreitung. Mögliche Werte: UP UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator für das Überschreiten des Schwellenwerts ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
ÜberschrittSchwellenwertInformationen.Indikatorname	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschritten hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdId	Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
href	URL-Verweis auf den Alarm. Datentyp: Zeichenfolge
resolvedSeverity	Erforderlich. Alarmschweregrad. Mögliche Werte: CLEAR KRITISCH GRÜNDLICH Geringfügig WARNUNG Datentyp: Zeichenfolge
GeplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm im Status „Geplanter Ausfall“ befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
probableUrsache	Erforderlich. Wahrscheinlichste Situation, die den Alarm auslöst. Verwenden Sie mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn dies im System verfügbar ist, stellt eine Reparaturaktion für bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAffected	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt Gültige Werte: wahr: Alarm wirkt sich auf Serviceleistung oder Verfügbarkeit aus. „falsch“: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
SpecificProblem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie 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. Ereignis nicht erstellt, fehlgeschlagen. Ereignis kann nicht gelöscht werden. Ereignis kann nicht aktualisiert werden. Das Ereignis ist nicht vorhanden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
AlarmChangedTime	Zeitpunkt (Datum und Uhrzeit), zu dem der Alarm in GMT auf dem System, für das der Alarm verantwortlich war, geändert wurde. Dieser Wert liegt im GlideDateTime-Format vor und befindet sich im Feld Time of event eines Datensatzes in der Tabelle „Ereignisse“ [em_events]. Dieser Wert wird aktualisiert, wenn Änderungen am Alarm von der betroffenen Ressource auftreten oder eine Änderung in 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 MINOR 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>"
  }
}

Offene Alarmmanagement-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 Ereignisdatensatzes in der Tabelle „Ereignisse“ [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. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
BetroffenerService	Liste von Objekten, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
impactedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Erforderlich. Bezeichner des vom Alarm betroffenen Services. Dieser Wert wird 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 Ereignis zugeordnet ist. Datentyp: Zeichenfolge
AlarmRaistTime	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
AlarmReportingTime	Datum und Uhrzeit, zu der das ESS seinen Alarm meldet. Dieser Wert kann vom Wert alarmRaisedTime abweichen. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit des Speichers in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	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
überschrittSchwellenwertInformationen.Richtung	Richtung der Schwellenwertüberschreitung. Mögliche Werte: UP UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator für das Überschreiten des Schwellenwerts ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
ÜberschrittSchwellenwertInformationen.Indikatorname	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschritten hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdId	Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externeAlarmId	Erforderlich. Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System zum Identifizieren und Verarbeiten der Alarmnutzlast als Ereignis. Dieser Wert muss leer sein, wenn er in der Nutzlast verwendet wird. Diese eindeutige ID wird vom System für das Ereignis generiert und als Teil der Nutzlast der Antwort gesendet. Datentyp: Zeichenfolge
resolvedSeverity	Erforderlich. Alarmschweregrad. Mögliche Werte: CLEAR KRITISCH GRÜNDLICH Geringfügig WARNUNG Datentyp: Zeichenfolge
GeplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm im Status „Geplanter Ausfall“ befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
probableUrsache	Erforderlich. Wahrscheinlichste Situation, die den Alarm auslöst. Verwenden Sie mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn dies im System verfügbar ist, stellt eine Reparaturaktion für bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAffected	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt Gültige Werte: wahr: Alarm wirkt sich auf Serviceleistung oder Verfügbarkeit aus. „falsch“: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Erforderlich. Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
SpecificProblem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Staat	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`festgelegt. Wenn der Status `Bereit`ist, wird in der Warnungstabelle [em_alert] eine Warnung erstellt und der Status ändert sich in `Verarbeitet`. Bei Status „ `Verarbeitet`“, `„Ignoriert“`oder „ `Fehler` “ 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. Ereignis nicht erstellt, fehlgeschlagen. Ereignis kann nicht gelöscht werden. Ereignis kann nicht aktualisiert werden. Das Ereignis ist nicht vorhanden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
BetroffenerService	Liste von Objekten, die einen oder mehrere vom Alarm betroffene Services identifizieren. Datentyp: Array `"affectedService":[ { "href": "String", "id": "String" }, ]`
impactedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Bezeichner des vom Alarm betroffenen Services. Dieser Wert wird 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 Ereignis zugeordnet ist. Datentyp: Zeichenfolge
AlarmRaistTime	Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge
AlarmReportingTime	Datum und Uhrzeit, zu der das ESS seinen Alarm meldet. Dieser Wert kann vom Wert alarmRaisedTime abweichen. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: alarmRaisedTime ist die Zeit der Alarmerkennung durch das Netzwerkelement (NE). alarmReportingTime ist die Alarmberichtszeit des Speichers in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	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
überschrittSchwellenwertInformationen.Richtung	Richtung der Schwellenwertüberschreitung. Mögliche Werte: UP UNTEN Datentyp: Zeichenfolge
CrossedThresholdInformation.Granularity	Granularität, mit der der Indikator für das Überschreiten des Schwellenwerts ausgewertet wird. Beispiel: `5 MINUTEN`. Datentyp: Zeichenfolge
ÜberschrittSchwellenwertInformationen.Indikatorname	Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.IndicatorUnit	Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge
CrossedThresholdInformation.observedValue	Nummer, die den Indikator identifiziert, der den Schwellenwert überschritten hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdId	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.thresholdRef	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
externeAlarmId	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 zum Identifizieren und Verarbeiten der Alarmnutzlast als Ereignis. Datentyp: Zeichenfolge
resolvedSeverity	Alarmschweregrad. Mögliche Werte: CLEAR KRITISCH GRÜNDLICH Geringfügig WARNUNG Datentyp: Zeichenfolge
GeplanteAusfallIndikation	Gibt an, dass sich das verwaltete Objekt für diesen Alarm im Status „Geplanter Ausfall“ befindet. Zum Beispiel geplante Wartung oder Außerbetriebnahme. Datentyp: Zeichenfolge
probableUrsache	Wahrscheinlichste Situation, die den Alarm auslöst. Verwenden Sie mit alarmType, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
vorgeschlageneReparaturaktionen	Wenn dies im System verfügbar ist, stellt eine Reparaturaktion für bereit, um das Problem zu beheben, das den Alarm auslöst. Datentyp: Zeichenfolge
serviceAffected	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt Gültige Werte: wahr: Alarm wirkt sich auf Serviceleistung oder Verfügbarkeit aus. „falsch“: Alarm hat keine Auswirkungen auf den Service. Standardwert: false Datentyp: Boolesch
sourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
SpecificProblem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Staat	Alarmstatus. Gültige Werte: Bereit Verarbeitet Ignoriert Fehler Wenn ein ungültiger Wert angegeben wird, wird der Status auf `Bereit`festgelegt. Wenn der Status `Bereit`ist, wird in der Warnungstabelle [em_alert] eine Warnung erstellt und der Status ändert sich in `Verarbeitet`. Bei Status „ `Verarbeitet`“, `„Ignoriert“`oder „ `Fehler` “ 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"
        }
     ] 
 }

Offene Alarmmanagement-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. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse“ [em_events]. Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 27. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
AlarmClearedTime	Zeitpunkt, zu dem 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
Klare System-ID	Erforderlich. Name der Instanz, aus der 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. Ereignis nicht erstellt, fehlgeschlagen. Ereignis kann nicht gelöscht werden. Ereignis kann nicht aktualisiert werden. Das Ereignis ist nicht vorhanden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
AlarmClearedTime	Zeitpunkt, zu dem 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
Klare System-ID	Name der Instanz, aus der 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>"
  }
}