Ereignisse werden mithilfe der Webservice-API an die Instanz übertragen

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

4 Minuten Lesedauer

Sie können eine Webservice-Schnittstelle verwenden, die von unterstützt wird ServiceNow, Das für das JSON-Objekt als Dateneingabe- und Ausgabeformat verwendet wird.

Vorbereitungen

Erforderliche Rolle: evt_mgmt_integration

Warum und wann dieser Vorgang ausgeführt wird

Verwenden Sie diese Webservice-API, um Datensätze mit einem einzelnen Aufruf in die Ereignistabelle [em_event] einzufügen:

https://<instancename>.service-now.com/api/global/em/jsonv2

Hinweis:

Business-Regeln in der Ereignistabelle werden nicht aufgerufen, wenn diese URL verwendet wird.

Fügen Sie einem Ereignis keine zusätzlichen Felder hinzu, indem Sie der Ereignistabelle [em_event] ein anwenderdefiniertes Feld hinzufügen. Zusätzliche Felder sollten jedoch in enthalten sein Zusätzliche Informationen [Zusätzliche_Info] Feld des Ereignisses. Weitere Informationen zum Einfügen zusätzlicher Felder in Ereignisse finden Sie unter Anwenderdefinierte Warnungsfelder.

Die URL im folgenden Format: http://<instancename>.service-now.com/em_event.do?JSONv2&sysparm_action=insertMultiple Wird auch unterstützt, wenn Sie Business-Regeln aktivieren möchten. Die Leistung der ersten URL ist jedoch überlegen.

Zum Arbeiten mit der URL, die mit endet =insertMultiple Fügen Sie dem MID-Server die folgenden Eigenschaften mit ihren jeweiligen Werten hinzu:

„mid.probe.event.queue.compress" – Wert: Falsch
„mid.probe.event.bulk_size" – Wert: 100
„mid.probe.event.endpoint.url" – Wert: Em_event.do?JSONv2 %26sysparm_action=insertMultiple

Prozedur

Senden Sie die Anforderung mit diesen Headern:


Parameter	Typ	Beschreibung
Akzeptieren	Zeichenfolge	Der zulässige Typ für diese Nachricht. Der Standardwert ist `Anwendung/JSON` .
Inhaltstyp	Zeichenfolge	Der Inhaltstyp für diese Nachricht. Der Standardwert ist `Anwendung/JSON` .
POST	Zeichenfolge	Der Anforderungstyp ist „POST“ mit einem oder mehreren nachgestellten Datensätzen.

Mindestens ein Ereignis im JSON-Format kann als Nutzlast des Webserviceaufrufs gesendet werden.

Ereignisfelder, die ausgefüllt werden müssen, sind:


Variable	Beschreibung
Quelle	Der Name des Ereignisquelltyps. Beispiel: SCOM oder SolarWinds.
Ereignis_Klasse	Bestimmte Instanz von source. Beispiel: `SCOM 2012 auf 10.20.30.40`
Knoten	Die Knoten Das Feld muss einen Bezeichner für den Host enthalten (Server/Switch/Router usw.). Für die das Ereignis ausgelöst wurde. Der Wert von Knoten Das Feld kann einer der folgenden Bezeichner des Hosts sein: Name FQDN IP MAC-Adresse Wenn er in der CMDB vorhanden ist, wird dieser Wert auch verwendet, um das Ereignis an das entsprechende ServiceNow-CI zu binden.
Ressource	Wenn sich das Ereignis auf ein Gerät bezieht, z. B. Datenträger, CPU oder Netzwerkadapter, oder für eine Anwendung oder einen Service, die auf einem Host ausgeführt wird, muss der Name des Geräts oder der Anwendung in diesem Feld ausgefüllt werden. Beispiel: `Datenträger C:\` Oder `Nic 001` Oder `Handels-Webanwendung` .
metric_name	Name der Metrik, die die Warnung ausgelöst hat. Beispiel: `Verwendeter Arbeitsspeicher` Oder `CPU-Auslastung insgesamt` .
Typ	Der Typ des Ereignisses. Dieser Typ kann dem ähneln Metrik_Name Feld, wird aber für die allgemeine Gruppierung von Ereignistypen verwendet.
message_key	Dieser Wert wird für die Deduplizierung von Ereignissen verwendet. Beispielsweise kann es zwei Ereignisse für dasselbe CI geben, wobei ein Ereignis die CPU von 50 % und das nächste Ereignis die CPU von 99 % hat. Wenn beide Ereignisse derselben ServiceNow-Warnung zugeordnet werden müssen, müssen sie denselben Nachrichtenschlüssel haben. Das Feld kann leer gelassen werden. In diesem Fall ist der Feldwert standardmäßig auf festgelegt `Quelle+Knoten+Typ+Ressource+Metrikname` . Die Message_key Sollte nur ausgefüllt werden, wenn ein besserer Bezeichner als der Standard vorhanden ist.
Schweregrad	Schweregrad des Ereignisses. ServiceNow-Werte für den Schweregrad reichen von 1 – Kritisch bis 5 – OK, mit dem Schweregrad 0 – leer. Ursprüngliche Schweregradwerte sollten als Teil der zusätzlichen Informationen gesendet werden.
Zusätzliche_Info	Dieses Feld hat das JSON-Schlüssel-/Wertformat und soll alle Informationen enthalten, die für den Anwender von Nutzen sein könnten. Es ist keinem vordefinierten ServiceNow-Ereignisfeld zugeordnet. Beispiele sind IDs von Objekten in der Ereignisquelle, Ereignispriorität (wenn sie nicht mit dem Schweregrad identisch ist), Zuweisungsgruppeninformationen usw. Werte in Zusätzliche Informationen Felder eines Ereignisses, die sich nicht im JSON-Schlüssel-/Wertformat befinden, werden beim Verarbeiten des Ereignisses auf das JSON-Format normalisiert.
time_of_event	Zeit, zu der das Ereignis am Ereignisursprung aufgetreten ist. Das Format ist: jjjj-MM-tt HH:mm:ss Die angegebene Zeit muss GMT entsprechen.
resolution_state	Optional: Um anzugeben, dass ein Ereignis gelöst wurde oder nicht mehr auftritt, verwenden einige Ereignisüberwachungen den Schweregrad „Löschen“, während andere Ereignisüberwachungen den Wert „Schließen“ für den Schweregrad verwenden. Dieses Feld wird für die Überwachungen verwendet, die Letzteres anbieten. Gültige Werte sind `Neu` Und `Wird Geschlossen` .

Um mehrere Datensätze mit einem einzigen Aufruf zu erstellen, lösen Sie den Ereignis-Webservice mithilfe der folgenden URL aus, wobei die <instance name>-Variable durch den Namen der erforderlichen Instanz ersetzt wird:

https://<instancename>.service-now.com/api/global/em/jsonv2

Beispiel, das die Nutzlast für zwei Ereignisse zeigt, die in einem einzelnen Webserviceaufruf gesendet werden:

{
  "records": [
    {
      "source": "SCOM",
      "event_class": "SCOM 2012 on scom.server.com",
      "resource": "D:",
      "node": "name.of.node.com",
      "metric_name": "Percentage Logical Disk Free Space",
      "type": "Disk space",
      "severity": "4",
      "description": "The disk D: on computer V-W2K8-abc.abc.com is running out of disk space. The value that exceeded the threshold is 38% free space.",
      "additional_info": {
        "scom-severity": "Medium",
        "metric-value": "38",
        "os_type": "Windows.Server.2008"
      }
    },
    {
      "source": "SCOM",
      "event_class": "SCOM 2012 on scom.server.com",
      "resource": "MSSQL-database-name",
      "node": "other.node.com",
      "metric_name": "DB Allocated Size (MB)",
      "type": "Database Storage",
      "severity": "3",
      "description": "High number of active connections for MSSQL-database-name running on name.of.node.com. Active connections exceed 5000.",
      "additional_info": {
        "scom-severity": "Medium",
        "metric-value": "38",
        "os_type": "Windows.Server.2008"
      }
    }
  ]
}

Um einen Datensatz mit einem einzelnen Aufruf zu erstellen, lösen Sie den Ereignis-Webservice mithilfe der folgenden URL aus, wobei die <instancename>-Variable durch den Namen der erforderlichen Instanz ersetzt wird:

http://<instancename>.service-now.com/api/global/em/jsonv2

Beispiel, das die Nutzlast für ein Ereignis zeigt, das in einem einzelnen Webserviceaufruf gesendet wird:

{
  "records": [
    {
      "source": "SCOM",
      "event_class": "SCOM 2007 on scom.server.com",
      "resource": "C:",
      "node": "name.of.node.com",
      "metric_name": "Percentage Logical Disk Free Space",
      "type": "Disk space",
      "severity": "4",
      "description": "The disk C: on computer V-W2K8-dfg.dfg.com is running out of disk space. The value that exceeded the threshold is 41% free space.",
      "additional_info": {
        "scom-severity": "Medium",
        "metric-value": "38",
        "os_type": "Windows.Server.2008"
      }
    }
  ]
}