--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Offene API für Alarmmanagement # Offene API für Alarmmanagement {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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](https://www.tmforum.org/resources/specification/tmf642-alarm-management-api-user-guide-v4-0/), 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](https://www.servicenow.com/docs/TUNVC~Tl7fCVThlRwBObEg#alarm-mgmt_dev-guide "Verwenden Sie die Alarm Management Open API, um Daten in der Tabelle „Ereignisse“ [em_event] zu erstellen und zu aktualisieren."). Die Alarm Management Open API ist vom TM Forum zertifiziert. ## Offene Alarm-Management-API: GET /sn_ind_tmf642/alarm_mgmt/alarm {#ariaid-title2} 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 {#alarm-GET-alarm__entry__2} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 1. Pfadparameter] {#alarm-GET-alarm__table_qcn_fkm_qtb__entry__2} | 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 {#alarm-GET-alarm__ul_n1h_htz_54b} 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 : 2. Abfrageparameter] {#alarm-GET-alarm__table_qcn_fkm_qtb} {#alarm-GET-alarm__entry__24} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 3. Parameter des Anforderungstexts (JSON)] ### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#alarm-GET-alarm__table_rgh_drm_qtb__entry__2} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 4. Anforderungskopfzeilen] {#alarm-GET-alarm__table_rgh_drm_qtb} {#alarm-GET-alarm__table_c2r_4gm_lsb__entry__2}{#alarm-GET-alarm__content-range-row}{#alarm-GET-alarm__content-type-row}{#alarm-GET-alarm__links-pagination-row}{#alarm-GET-alarm__x-total-count-descr} | 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 {#alarm-GET-alarm__ul_zzk_sdm_lsb} | | X-Gesamtzahl | Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. | [Tabelle : 5. Antwortkopfzeilen] {#alarm-GET-alarm__table_c2r_4gm_lsb} ### 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-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#alarm-GET-alarm__table_qbg_4cm_lsb__entry__2}{#alarm-GET-alarm__tmf-get-status-200-p}{#alarm-GET-alarm__tmf-get-status-206-entry}{#alarm-GET-alarm__tmf-get-status-400-entry}{#alarm-GET-alarm__tmf-get-status-404-entry} | 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 {#alarm-GET-alarm__ul_rys_1gy_fsb} | | 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. | [Tabelle : 6. Statuscodes] {#alarm-GET-alarm__table_qbg_4cm_lsb} ### Parameter des Antwort-Haupttexts (JSON) {#alarm-GET-alarm__table_zjc_fbg_qtb__entry__2}{#alarm-GET-alarm__alm-mgmt-affectedService-entry}{#alarm-GET-alarm__alm-mgmt-affectedServiceHREF-entry}{#alarm-GET-alarm__alm-mgmt-create-alarmobj-href-entry}{#alarm-GET-alarm__alm-mgmt-specificProb-ph} | 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. {#alarm-GET-alarm__ul_mbt_1rf_ynb} 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 {#alarm-GET-alarm__ul_fsb_jlg_ynb} 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 {#alarm-GET-alarm__ul_vcp_c4f_ynb} 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. {#alarm-GET-alarm__ul_omz_dnf_ynb} 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 {#alarm-GET-alarm__ul_ilh_3jt_xnb}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 | [ ] {#alarm-GET-alarm__table_zjc_fbg_qtb} ### 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} {#ariaid-title3} 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 {#alarm-GET-alarm-id__entry__2} | Name | Beschreibung | |-|-| | id | Eindeutiger Identifier des abzurufenden Datensatzes. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse" \[em_event\]. Datentyp: Zeichenfolge | [Tabelle : 7. Pfadparameter] {#alarm-GET-alarm-id__entry__6} | 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 {#alarm-GET-alarm-id__ul_n1h_htz_54b} Standardwert: Alle Felder Datentyp: Zeichenfolge | [Tabelle : 8. Abfrageparameter] {#alarm-GET-alarm-id__entry__10} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 9. Parameter des Anforderungstexts (JSON)] ### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#alarm-GET-alarm-id__entry__14}{#alarm-GET-alarm-id__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | [Tabelle : 10. Anforderungskopfzeilen] {#alarm-GET-alarm-id__entry__18} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 11. Antwortkopfzeilen] ### 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-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#alarm-GET-alarm-id__entry__22}{#alarm-GET-alarm-id__entry-200-status-code} | 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. {#alarm-GET-alarm-id__ul_rjf_fqw_rpb} | | 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. | [Tabelle : 12. Statuscodes] ### Parameter des Antwort-Haupttexts (JSON) {#alarm-GET-alarm-id__table_gtd_dbg_qtb__entry__2}{#alarm-GET-alarm-id__alm-mgmt-affectedService-entry}{#alarm-GET-alarm-id__alm-mgmt-affectedServiceHREF-entry}{#alarm-GET-alarm-id__alm-mgmt-create-alarmobj-href-entry}{#alarm-GET-alarm-id__alm-mgmt-specificProb-ph} | 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. {#alarm-GET-alarm-id__ul_mbt_1rf_ynb} 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 {#alarm-GET-alarm-id__ul_fsb_jlg_ynb} 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 {#alarm-GET-alarm-id__ul_vcp_c4f_ynb} 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. {#alarm-GET-alarm-id__ul_omz_dnf_ynb} 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 {#alarm-GET-alarm-id__ul_ilh_3jt_xnb}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 | [ ] {#alarm-GET-alarm-id__table_gtd_dbg_qtb} ### 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} {#ariaid-title4} 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 {#alarm-PATCH__entry__2} | Name | Beschreibung | |-|-| | id | Eindeutiger Identifier des zu aktualisierenden Datensatzes. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse" \[em_event\]. Datentyp: Zeichenfolge | [Tabelle : 13. Pfadparameter] {#alarm-PATCH__entry__6} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 14. Abfrageparameter] {#alarm-PATCH__table_kmr_mjs_xnb__entry__2}{#alarm-PATCH__alm-mgmt-affectedService-entry}{#alarm-PATCH__alm-mgmt-affectedServiceHREF-entry}{#alarm-PATCH__alm-mgmt-perceivedSeverity-desc}{#alarm-PATCH__alm-mgmt-specificProb-ph} | 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. {#alarm-PATCH__ul_kkj_4jh_ynb} 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 {#alarm-PATCH__ul_fsb_jlg_ynb} 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 {#alarm-PATCH__ul_vcp_c4f_ynb} 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. {#alarm-PATCH__ul_omz_dnf_ynb} Standardwert: false Datentyp: Boolesch | | SpecificProblem | Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCause, um den Alarm zu qualifizieren. Datentyp: Zeichenfolge | [Tabelle : 15. Parameter des Anforderungstexts (JSON)] {#alarm-PATCH__table_kmr_mjs_xnb} ### Header 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#alarm-PATCH__entry__56}{#alarm-PATCH__accept-JSON-only-entry-RESTAPI}{#alarm-PATCH__content_type-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 16. Anforderungskopfzeilen] {#alarm-PATCH__table_jwc_bxs_xnb__entry__2} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 17. Antwortkopfzeilen] {#alarm-PATCH__table_jwc_bxs_xnb} ### 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-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#alarm-PATCH__table_ifj_lyb_ynb__entry__2} | 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:\ . * 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. {#alarm-PATCH__ul_f4x_sdb_ynb} | [Tabelle : 18. Statuscodes] {#alarm-PATCH__table_ifj_lyb_ynb} ### Parameter des Antwort-Haupttexts (JSON) {#alarm-PATCH__entry__72} | 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://.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_" \ --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\":\"\", \"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_" } } ## Offene Alarmmanagement-API -- POST /sn_ind_tmf642/alarm_mgmt/alarm {#ariaid-title5} 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](https://www.servicenow.com/docs/access?context=alert-management-rule&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). 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 {#alarm-POST-create__entry__2} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 19. Pfadparameter] {#alarm-POST-create__entry__6} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 20. Abfrageparameter] {#alarm-POST-create__entry__10}{#alarm-POST-create__alm-mgmt-affectedService-entry}{#alarm-POST-create__alm-mgmt-affectedServiceHREF-entry}{#alarm-POST-create__alm-mgmt-create-alarmobj-href-entry}{#alarm-POST-create__alm-mgmt-create-alarmtype}{#alarm-POST-create__alm-mgmt-perceivedSeverity-desc}{#alarm-POST-create__alm-mgmt-specificProb-ph} | 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. {#alarm-POST-create__ul_mbt_1rf_ynb} 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 {#alarm-POST-create__ul_fsb_jlg_ynb} 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 {#alarm-POST-create__ul_vcp_c4f_ynb} 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. {#alarm-POST-create__ul_omz_dnf_ynb} 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 {#alarm-POST-create__ul_ilh_3jt_xnb}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 | [Tabelle : 21. Parameter des Anforderungstexts (JSON)] ### Header 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#alarm-POST-create__entry__72}{#alarm-POST-create__accept-JSON-only-entry-RESTAPI}{#alarm-POST-create__content_type-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 22. Anforderungskopfzeilen] {#alarm-POST-create__table_vrm_1xs_xnb__entry__2} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 23. Antwortkopfzeilen] {#alarm-POST-create__table_vrm_1xs_xnb} ### 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-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#alarm-POST-create__table_bly_lyb_ynb__entry__2} | 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:\ . * 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. {#alarm-POST-create__ul_f4x_sdb_ynb} | [Tabelle : 24. Statuscodes] {#alarm-POST-create__table_bly_lyb_ynb} ### Parameter des Antwort-Haupttexts (JSON) {#alarm-POST-create__entry__88}{#alarm-POST-create__d3018e79}{#alarm-POST-create__d3018e92}{#alarm-POST-create__d3018e411}{#alarm-POST-create__d3018e350} | 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. {#alarm-POST-create__d3018e467} 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 {#alarm-POST-create__d3018e147} 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 {#alarm-POST-create__d3018e256} 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. {#alarm-POST-create__d3018e330} 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 {#alarm-POST-create__d3018e558}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://.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":"", "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":"", "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 {#ariaid-title6} 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 {#alarm-POST-clear__entry__2} | 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 : 25. Pfadparameter] {#alarm-POST-clear__entry__6} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 26. Abfrageparameter] {#alarm-POST-clear__entry__10} | 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 | [Tabelle : 27. Parameter des Anforderungstexts (JSON)] ### Header 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#alarm-POST-clear__entry__18}{#alarm-POST-clear__accept-JSON-only-entry-RESTAPI}{#alarm-POST-clear__content_type-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 28. Anforderungskopfzeilen] {#alarm-POST-clear__entry__24} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 29. Antwortkopfzeilen] ### 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-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#alarm-POST-clear__entry__28} | 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:\ . * 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. {#alarm-POST-clear__ul_f4x_sdb_ynb} | [Tabelle : 30. Statuscodes] ### Parameter des Antwort-Haupttexts (JSON) {#alarm-POST-clear__entry__34} | 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://.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_/clear" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"alarmClearedTime\": \"2017-08-15 06:04:15\", \"clearSystemId\": \"\", \"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\" }" \ --user 'user':'password' Antworttext. { "result": { "alarmClearedTime": "2017-08-15 06:04:15", "clearSystemId": "", "clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00", "id": "6e116bb8db09201087b9a8394b961950_" } }