Alarmmanagement – API öffnen

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

22 Minuten Lesedauer

Die Alarmmanagement Offen Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Ereignisse“ [em_event] und „Warnung“ [em_Alert] bereit.

Die Telekommunikation Alarmmanagement Offen API (sn_ind_tmf642) ist ein ServiceNow® Implementierung der Spezifikation „TM Forum Open API“. Diese API basiert auf TMF642 – Alarmmanagement-API – REST-Spezifikation Release 20 , April 2020.

Der aufrufende Anwender muss auf zugreifen sn_ind_tmf642.Alarm_mgmt_Integration Endpunkt.

Diese API wird in bereitgestellt sn_ind_tmf642 Namespace.

Die Spezifikation der TM Forum Open API erfordert eine synchrone Antwort für jede eingehende Anforderung, die sie empfängt. Wenden Sie Korrelation und Deduplizierung im Operational Support System (OSS) der Quelle an, bevor Sie Nutzlasten an das System weiterleiten.

Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterDie Alarmmanagement – Entwicklerleitfaden für offene API .

Die Alarmmanagement Offen API ist vom TM-Forum zertifiziert.

TMF-Konformitätslogo

Alarmmanagement – API öffnen – 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
AlarmRaisedTime	Datum, an dem der Alarm ausgelöst wurde. Nur Alarme mit einem Datum, das dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: AlarmedObject AlarmRaisedTime Alarmtyp CrossedThresholdInformation ExternalAlarmId id WahrgenommenSchweregrad ProbableUrsache 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. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel in der Tabelle Ereignisse [em_event].
limit	Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Standardwert: 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. Datentyp: Zahl Standard: 0
ProbableUrsache	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. Anforderungstext-Parameter (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	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` Und `Grenzwert = 3` , Der Wert von Content-RangeHeader ist `Elemente 3-5` .
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung).
206	Teilressource als Antwort zurückgegeben (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 von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten `"affectedService":[ { "href": "String", "id": "String" }, ]`
AffectedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Bezeichner des Service, der vom Alarm betroffen ist. Dieser Wert ist dem betroffenen Konfigurationselement (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
AlarmRaisedTime	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 von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). Die alarmReportingTimeIst die Speicherzeit des Alarmberichts in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. Datentyp: Objekt `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
CrossedThresholdInformation.direction	Richtung des Schwellenwertüberschreitens. Gültige Werte: AUSGEFALLEN AKTIV Datentyp: Zeichenfolge
crossedThresholdInformation.granularity	Granularität, mit der der Indikator für die 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 Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.ThresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-ID	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-Ref	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
ExternalAlarmId	Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
href	URL von Ressource . Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Daten Typ: Zeichenfolge
WahrgenommenSchweregrad	Alarmschweregrad. Gültige Werte: LÖSCHEN CRITICAL SCHWERWIEGEND GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
PlannedOutageIndication	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge
ProbableUrsache	Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge
ProposedRepairActions	Wenn für das System verfügbar, bietet eine Reparaturaktion zur Behebung des Problems, das den Alarm auslöst. Datentyp: Zeichenfolge
Servicerelevant	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: Wahr: Der Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. Falsch: Alarm wirkt sich nicht auf den Service aus. Standardwert: false Datentyp: Boolesch
SourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Fehler Ignoriert Bereit Verarbeitet Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit` . Wenn der Status lautet `Bereit` , Eine Warnung wird in der Tabelle Warnung [em_Alert] erstellt, und der Status wird dann zu `Verarbeitet` . Wenn der Status lautet `Verarbeitet` , `Ignoriert` , Oder `Fehler` Es 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"
   }
]

Alarmmanagement – API öffnen – 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. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel der Tabelle Ereignisse [em_event].

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 AlarmRaisedTime Alarmtyp CrossedThresholdInformation ExternalAlarmId id WahrgenommenSchweregrad ProbableUrsache Quelle SourceSystemId Status type Standardwert: Alle Felder Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstext-Parameter (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 REST API-HTTP-Antwortcodes .

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem 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 „Ereignis“ [em_event] oder „Warnung“ [em_Alert] nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Betroffener Service	Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten `"affectedService":[ { "href": "String", "id": "String" }, ]`
AffectedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Bezeichner des Service, der vom Alarm betroffen ist. Dieser Wert ist dem betroffenen Konfigurationselement (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
AlarmRaisedTime	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 von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). Die alarmReportingTimeIst die Speicherzeit des Alarmberichts in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. Datentyp: Objekt `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
CrossedThresholdInformation.direction	Richtung des Schwellenwertüberschreitens. Gültige Werte: AUSGEFALLEN AKTIV Datentyp: Zeichenfolge
crossedThresholdInformation.granularity	Granularität, mit der der Indikator für die 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 Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.ThresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-ID	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-Ref	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
ExternalAlarmId	Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
href	URL von Die Ressource . Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Datentyp: Zeichenfolge
WahrgenommenSchweregrad	Alarmschweregrad. Gültige Werte: LÖSCHEN CRITICAL SCHWERWIEGEND GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
PlannedOutageIndication	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge
ProbableUrsache	Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge
ProposedRepairActions	Wenn für das System verfügbar, bietet eine Reparaturaktion zur Behebung des Problems, das den Alarm auslöst. Datentyp: Zeichenfolge
Servicerelevant	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: Wahr: Der Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. Falsch: Alarm wirkt sich nicht auf den Service aus. Standardwert: false Datentyp: Boolesch
SourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Fehler Ignoriert Bereit Verarbeitet Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit` . Wenn der Status lautet `Bereit` , Eine Warnung wird in der Tabelle Warnung [em_Alert] erstellt, und der Status wird dann zu `Verarbeitet` . Wenn der Status lautet `Verarbeitet` , `Ignoriert` , Oder `Fehler` Es 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"
}

Alarmmanagement – API öffnen – PATCH /sn_ind_tmf642/Alarm_mgmt/Alarm/{ID}

Aktualisiert einen angegebenen Alarm und alle zugehörigen Warnungen.

Dieser Endpunkt schreibt den Antworttext in den Zusätzliche Informationen Feld 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. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel der Tabelle Ereignisse [em_event].

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Betroffener Service	Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten `"affectedService":[ { "href": "String", "id": "String" }, ]`
AffectedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Erforderlich. Bezeichner des Service, der vom Alarm betroffen ist. Dieser Wert ist dem betroffenen Konfigurationselement (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge
AlarmChangedTime	Gibt das Datum und die Uhrzeit der letzten Alarmänderung im Alarmbesitzer-System an. Jede Änderung am Alarm aktualisiert diesen Wert, unabhängig davon, ob er von der Ressource mit Alarm stammt oder durch eine Änderung vom Client ausgelöst wurde. Datentyp: Zeichenfolge
Alarmdetails	Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge
Alarmeskalation	Kennzeichnung, die eine Eskalation im Alarmschweregrad angibt. Gültige Werte: Wahr: Es gibt eine Eskalation im Alarmschweregrad. Falsch: Der Alarmschweregrad ist gleich oder niedriger. Standardwert: false Datentyp: Boolesch
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. Datentyp: Objekt `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
CrossedThresholdInformation.direction	Richtung des Schwellenwertüberschreitens. Gültige Werte: AUSGEFALLEN AKTIV Datentyp: Zeichenfolge
crossedThresholdInformation.granularity	Granularität, mit der der Indikator für die 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 Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.ThresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-ID	Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-Ref	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
href	URL-Verweis auf den Alarm. Datentyp: Zeichenfolge
WahrgenommenSchweregrad	Erforderlich. Alarmschweregrad. Gültige Werte: LÖSCHEN CRITICAL SCHWERWIEGEND GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
PlannedOutageIndication	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge
ProbableUrsache	Erforderlich. Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge
ProposedRepairActions	Wenn für das System verfügbar, bietet eine Reparaturaktion zur Behebung des Problems, das den Alarm auslöst. Datentyp: Zeichenfolge
Servicerelevant	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: Wahr: Der Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. Falsch: Alarm wirkt sich nicht auf den Service aus. Standardwert: false Datentyp: Boolesch
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter, 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 REST API-HTTP-Antwortcodes .

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	Datum und Uhrzeit der Alarmänderung in GMT im Alarmbesitzer-System. Dieser Wert wird aktualisiert, wenn Änderungen am Alarm aus der Ressource mit Alarm auftreten oder eine Änderung aus 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 „GERING“ 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>"
  }
}

Alarmmanagement – API öffnen – POST /sn_ind_tmf642/Alarm_mgmt/Alarm

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

Wenn der Alarmdatensatz erstellt wird, wird eine ID für den Alarm in hinzugefügt Message keyFeld.

Ein Warnungsdatensatz kann auch basierend auf erstellt werden Warnungsverwaltungsregeln .

Dieser Endpunkt schreibt den Antworttext in den Zusätzliche Informationen Feld 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. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Betroffener Service	Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten `"affectedService":[ { "href": "String", "id": "String" }, ]`
AffectedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Erforderlich. Bezeichner des Service, der vom Alarm betroffen ist. Dieser Wert ist dem betroffenen Konfigurationselement (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
AlarmRaisedTime	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 von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). Die alarmReportingTimeIst die Speicherzeit des Alarmberichts in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	Erforderlich. Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. Datentyp: Objekt `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
CrossedThresholdInformation.direction	Richtung des Schwellenwertüberschreitens. Gültige Werte: AUSGEFALLEN AKTIV Datentyp: Zeichenfolge
crossedThresholdInformation.granularity	Granularität, mit der der Indikator für die 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 Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.ThresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-ID	Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-Ref	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
ExternalAlarmId	Erforderlich. Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Dieser Wert muss leer sein, wenn er in der Nutzlast verwendet wird. Das System generiert diese eindeutige ID für das Ereignis und sendet sie als Teil der Antwortnutzlast. Datentyp: Zeichenfolge
WahrgenommenSchweregrad	Erforderlich. Alarmschweregrad. Gültige Werte: LÖSCHEN CRITICAL SCHWERWIEGEND GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
PlannedOutageIndication	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge
ProbableUrsache	Erforderlich. Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge
ProposedRepairActions	Wenn für das System verfügbar, bietet eine Reparaturaktion zur Behebung des Problems, das den Alarm auslöst. Datentyp: Zeichenfolge
Servicerelevant	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: Wahr: Der Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. Falsch: Alarm wirkt sich nicht auf den Service aus. Standardwert: false Datentyp: Boolesch
SourceSystemId	Erforderlich. Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Fehler Ignoriert Bereit Verarbeitet Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit` . Wenn der Status lautet `Bereit` , Eine Warnung wird in der Tabelle Warnung [em_Alert] erstellt, und der Status wird dann zu `Verarbeitet` . Wenn der Status lautet `Verarbeitet` , `Ignoriert` , Oder `Fehler` Es 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 REST API-HTTP-Antwortcodes .

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
Betroffener Service	Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten `"affectedService":[ { "href": "String", "id": "String" }, ]`
AffectedService.href	URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge
affectedService.id	Bezeichner des Service, der vom Alarm betroffen ist. Dieser Wert ist dem betroffenen Konfigurationselement (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
AlarmRaisedTime	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 von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). Die alarmReportingTimeIst die Speicherzeit des Alarmberichts in der EMS-Alarmliste. Datentyp: Zeichenfolge
Alarmtyp	Alarmkategorie. Datentyp: Zeichenfolge
CrossedThresholdInformation	Details zum überschrittenen Schwellenwert. Datentyp: Objekt `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
CrossedThresholdInformation.direction	Richtung des Schwellenwertüberschreitens. Gültige Werte: AUSGEFALLEN AKTIV Datentyp: Zeichenfolge
crossedThresholdInformation.granularity	Granularität, mit der der Indikator für die 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 Schwellenwert überschreitet. Datentyp: Zeichenfolge
CrossedThresholdInformation.ThresholdCrossingDescription	Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-ID	Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge
CrossedThresholdInformation.threshold-Ref	URL des Schwellenwertobjekts. Datentyp: Zeichenfolge
ExternalAlarmId	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 zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Datentyp: Zeichenfolge
WahrgenommenSchweregrad	Alarmschweregrad. Gültige Werte: LÖSCHEN CRITICAL SCHWERWIEGEND GERINGFÜGIG WARNUNG Datentyp: Zeichenfolge
PlannedOutageIndication	Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Zum Beispiel geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge
ProbableUrsache	Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge
ProposedRepairActions	Wenn für das System verfügbar, bietet eine Reparaturaktion zur Behebung des Problems, das den Alarm auslöst. Datentyp: Zeichenfolge
Servicerelevant	Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: Wahr: Der Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. Falsch: Alarm wirkt sich nicht auf den Service aus. Standardwert: false Datentyp: Boolesch
SourceSystemId	Instanz-ID des Quellalarms. Datentyp: Zeichenfolge
Spezifisches Problem	Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge
Status	Alarmstatus. Gültige Werte: Fehler Ignoriert Bereit Verarbeitet Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit` . Wenn der Status lautet `Bereit` , Eine Warnung wird in der Tabelle Warnung [em_Alert] erstellt, und der Status wird dann zu `Verarbeitet` . Wenn der Status lautet `Verarbeitet` , `Ignoriert` , Oder `Fehler` Es 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"
        }
     ] 
 }

Alarmmanagement – API öffnen – 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. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel der Tabelle Ereignisse [em_Events].

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 27. Anforderungstext-Parameter (JSON)
Name	Beschreibung
AlarmClearedTime	Datum und Uhrzeit, zu der der Alarm an der Quelle gelöscht wird. Datentyp: Zeichenfolge Tabelle: Im Feld „Zeit des Ereignisses“ der Tabelle „Ereignisse“ [em_Events].
Klare SystemId	Erforderlich. Name der Instanz, von der aus alarmClearedVorgang wurde aufgerufen. Datentyp: Zeichenfolge
ClearUserId	Erforderlich. Eindeutige ID des Anwenders, der den aufgerufen hat alarmClearedVorgang. 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 REST API-HTTP-Antwortcodes .

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	Datum und Uhrzeit, zu der der Alarm an der Quelle gelöscht wird. Datentyp: Zeichenfolge Tabelle: Im Feld „Zeit des Ereignisses“ der Tabelle „Ereignisse“ [em_Events].
Klare SystemId	Name der Instanz, von der aus alarmClearedVorgang wurde aufgerufen. Datentyp: Zeichenfolge
ClearUserId	Eindeutige ID des Anwenders, der den aufgerufen hat alarmClearedVorgang. Datentyp: Zeichenfolge
href	URL des Alarms. Datentyp: Zeichenfolge
id	Eindeutige ID. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel des Datensatzes in der Tabelle Ereignisse [em_Events].

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>"
  }
}