Entwicklerleitfaden Für Synthetic-Überwachung

API-Referenz für Australien

Release

australia

ft:locale

de-DE

ft:publication_title

API-Referenz für Australien

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

Entwicklerleitfaden Für Synthetic-Überwachung

Freigeben Version: Australia

Aktualisiert 29. April 2026

9 Minuten Lesedauer

APIs zur Synthetic-Überwachung verwenden Erstellen Sie mehrere Synthetic-Überwachungen in einem einzigen Vorgang.

Dieser Entwicklerleitfaden enthält Informationen zur Verwendung Synthetic monitoring APIs zum Massenerstellung von Monitoren über Postman oder Terminal.

Die vollständige Referenzdokumentation für APIs zur Synthetic-Überwachung finden Sie unter:

Importieren und erstellen Sie synthetische Monitore in Massenproduktion mithilfe der API

Erstellen Sie mehrere Synthetic-Monitore gleichzeitig, indem Sie Rohdaten importieren JSON oder CSV Dateien über SyntheticsAsyncMassenErstellen API.

Vorbereitungen

Erforderliche Rolle: sn_sow_synthetics.synthetics_admin oder sn_sow_synthetics.synthetics_editor

Gültige Anmeldeinformationen für ServiceNow-Instanz
Zugriff auf HTTP-Endpunkt
Basis-URL: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
Vorbereitete JSON- oder CSV-Rohdatei mit Überwachungsdaten mit Pflichtfeldern:
- Überwachungsname
- SYS_ID des HTTP-Endpunkts
- Sys_ID des übergeordneten Service
- Sys_ID des Standorts
- sys-ID der Supportgruppe
- Intervall (Häufigkeit)
- METHODE („GET“, „POST“, „PUT“, „DELETE“, „PATCH“, „HEAD“)
- Assertionsfeld

Eines der folgenden Tools: Terminal (mit Curl-Befehl), Postman oder Skripting-Umgebung.

Warum und wann dieser Vorgang ausgeführt wird

Die SyntheticsAsyncMassenErstellen API verwendet einen zweistufigen Prozess:

Erstellt eine Auftrags-ID, indem Sie Ihre Überwachungsdatendatei hochladen.
Überprüft den Auftragsstatus, um den Erstellungsstatus zu überwachen.

Sie können auf diese API mit einer der folgenden Methoden zugreifen:

Terminal mit Curl-Befehlen
Postman-Anwendung
Anwenderdefiniertes Skripts

Die API erfordert entweder eine Standardauthentifizierung oder eine oauth-Token-Authentifizierung.

Standardauthentifizierung:
```
Curl -u „username:password“
```

OAuth-Token:

Curl -H „Autorisierung: Bearer-<your-oauth-token>“

Prozedur

Bereiten Sie Ihre Überwachungsdatendatei im JSON- oder CSV-Rohformat vor.
Wählen Sie Ihre bevorzugte Methode (Terminal, Postman oder Skript) aus.
Rufen Sie den API-Endpunkt für den Massenimport auf, um die Datei hochzuladen und eine Auftrags-ID zu generieren.
Verwenden Sie die Statusprüfungs-URL, um den Erstellungsstatus der Überwachung zu überprüfen.
Überprüfen Sie die Antwort auf erfolgreiche Überwachungserstellung oder Fehlerdetails.
Aktualisieren Sie die Quelldatei mit den richtigen Daten (wenn Fehler auftreten), und übermitteln Sie sie erneut.

Ergebnisse

Überwachungen werden in der ServiceNow-Instanz erstellt. Die API-Antwort gibt Folgendes an:

Verarbeitungsstatus (Verarbeitung/Abgeschlossen)
Monitore wurden erfolgreich erstellt
Fehlgeschlagene Überwachungen mit Fehlerdetails (Pflichtfelder fehlen, ungültige sys_IDs usw.)

Erstellen Sie Massen-Monitore mithilfe des Terminals

Verwenden Sie Curl-Befehle im Terminal, um mehrere Synthetic-Überwachungen gleichzeitig zu erstellen, indem Sie JSON- oder CSV-Dateien über importieren SyntheticsAsyncMassenErstellen API.

Vorbereitungen

Erforderliche Rolle: sn_sow_synthetics.synthetics_admin oder sn_sow_synthetics.synthetics_editor

Gültige Anmeldeinformationen für ServiceNow-Instanz
Zugriff auf HTTP-Endpunkt
Basis-URL: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
Vorbereitete JSON- oder CSV-Rohdatei mit Überwachungsdaten mit Pflichtfeldern:
- Überwachungsname
- SYS_ID des HTTP-Endpunkts
- Sys_ID des übergeordneten Service
- Sys_ID des Standorts
- sys-ID der Supportgruppe
- Intervall (Häufigkeit)
- METHODE („GET“, „POST“, „PUT“, „DELETE“, „PATCH“, „HEAD“)
- Assertionsfeld

Warum und wann dieser Vorgang ausgeführt wird

Die SyntheticsAsyncMassenErstellen API verwendet einen zweistufigen Prozess, wenn über das Terminal zugegriffen wird. Laden Sie zuerst Ihre Überwachungsdatendatei mit einem Curl-Befehl hoch, um eine Auftrags-ID zu generieren. Überprüfen Sie dann den Auftragsstatus, um die Monitorerstellung zu überprüfen. Die API verarbeitet Datensätze asynchron und bietet detailliertes Feedback zu erfolgreichen Erstellungen und Fehlern.

Je nachdem, ob Sie eine JSON- oder CSV-Datei hochladen, sind verschiedene Curl-Befehle erforderlich.

Prozedur

Öffnen Sie das Terminal auf Ihrem System.
Navigieren Sie zu dem Verzeichnis, das Ihre Überwachungsdatendatei enthält.

Führen Sie den entsprechenden Curl-Befehl aus, um Ihre Datei hochzuladen und eine Auftrags-ID zu erstellen.

Für JSON-Dateien:

curl -X POST "https://{your-instance}.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -u "admin:password" \
  -d @{filename}.json

Für CSV-Dateien:

curl -X POST "https://{your-instance}.service-now.com/api/sn_now_synthetics/v1/synthetics_async_bulk_create?filename=filename.csv" \
  -H "Content-Type: text/csv" \
  -H "Accept: application/json" \
  -u "admin:password" \
  --d "$(jq -Rs '{csv_content: .}'filename.csv"

Ersetzen Sie die folgenden Platzhalter:

{Your-instance} : Name der ServiceNow-Instanz
{Dateiname} : Der Name Ihrer Überwachungsdatendatei

Die API gibt eine Antwort zurück, die eine Auftrags-ID und eine Statusüberprüfungs-URL enthält.

{
  "result": {
    "job_id": "abc123def456",
    "status": "processing",
    "status_check_url": "https://{your-instance}.service-now.com/api/now/synthetic/monitor/bulk/status/abc123def456"
  }
}

Kopieren Sie die Statusprüfungs-URL aus der Antwort.

Führen Sie den Curl-Befehl für die Statusprüfung aus, um den Auftragsverarbeitungsstatus zu überprüfen.

curl -X GET "https://{your-instance}.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/{job_id}" \
  -H "Accept: application/json" \
  -u "{username}:{password}"

Die API gibt eine der folgenden Statusantworten zurück:

Verarbeitungsstatus:

{
  "result": {
    "job_id": "abc123def456",
    "status": "processing",
    "total_records": 10,
    "processed_records": 3
  }
}

Abschlussstatus (erfolgreich):

{
  "result": {
    "job_id": "abc123def456",
    "status": "complete",
    "total_records": 10,
    "successful_records": 10,
    "failed_records": 0,
    "details": []
  }
}

Status „Abgeschlossen“ (mit Fehlern):

{
  "result": {
    "job_id": "abc123def456",
    "status": "complete",
    "total_records": 10,
    "successful_records": 8,
    "failed_records": 2,
    "details": [
      {
        "name": "Monitor_API_001",
        "status": "failed",
        "error_code": "MISSING_REQUIRED_FIELD",
        "reason": "CMDB CI is required"
      },
      {
        "name": "Monitor_API_002",
        "status": "failed",
        "error_code": "INVALID_REFERENCE",
        "reason": "Location not found for this sys_id"
      }
    ]
  }
}

Wenn der Status „wird verarbeitet“ ist, warten Sie einige Minuten, und wiederholen Sie den Befehl zur Statusprüfung.
Das System verarbeitet Datensätze asynchron. Fahren Sie mit der Überprüfung fort, bis sich der Status in „Abgeschlossen“ ändert.
Wenn Überwachungen nicht erstellt werden konnten, überprüfen Sie die Fehlerdetails in der Antwort.
1. Identifizieren Sie den Namen der fehlgeschlagenen Überwachung aus Kompiliert Details.
2. Überprüfen Sie den angegebenen Fehlercode und den angegebenen Grund.
3. Aktualisieren Sie Ihre JSON- oder CSV-Quelldatei, um die Datenprobleme zu beheben.
  Häufige Fehler:
  - Fehlende Pflichtfelder (CMDB-CI, Standort, Methode)
  - Ungültige sys_ID-Referenzen, die in der Instanz nicht vorhanden sind
  - Falsche Datenformate
4. Übermitteln Sie die korrigierte Datei erneut, indem Sie den Befehl „Curl hochladen“ wiederholen.

Ergebnisse

Überwachungen werden in Ihrer ServiceNow-Instanz erstellt. Erfolgreich erstellte Monitore sind sofort zur Verwendung verfügbar. Fehlgeschlagene Überwachungen werden mit bestimmten Fehlerdetails gemeldet, sodass Sie die Daten korrigieren und erneut übermitteln können.

Workflow-Beispiel abschließen

Schritt 1: JSON-Datei hochladen

curl -X POST "https://myinstance.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -u "admin:password123" \
  -d @monitor_data.json

Antwort:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "processing",
    "status_check_url": "https://myinstance.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/status/xyz789abc123"
  }
}

Schritt 2: Status überprüfen

curl -X GET "https://myinstance.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/status/xyz789abc123" \
  -H "Accept: application/json" \
  -u "admin:password123"

Endgültige Antwort:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "complete",
    "total_records": 5,
    "successful_records": 5,
    "failed_records": 0
  }
}

Nächste Maßnahme

Überprüfen Sie nach der erfolgreichen Erstellung Ihre Monitore in der ServiceNow-UI, indem Sie zu navigieren Synthetics-Überwachung > Monitorean. Sie können zusätzliche Überwachungseinstellungen und -Zeitpläne konfigurieren , Nach Bedarf.

Erstellen Sie Massen-Monitore mit Postman

Verwenden Sie Postman, um mehrere Synthetic-Monitore gleichzeitig zu erstellen, indem Sie JSON- oder CSV-Dateien über importieren SyntheticsAsyncMassenErstellen API.

Vorbereitungen

Erforderliche Rolle: sn_sow_synthetics.synthetics_admin oder sn_sow_synthetics.synthetics_editor

Gültige Anmeldeinformationen für ServiceNow-Instanz
Zugriff auf HTTP-Endpunkt
Basis-URL: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
Vorbereitete JSON- oder CSV-Rohdatei mit Überwachungsdaten mit Pflichtfeldern:
- Überwachungsname
- SYS_ID des HTTP-Endpunkts
- Sys_ID des übergeordneten Service
- Sys_ID des Standorts
- sys-ID der Supportgruppe
- Intervall (Häufigkeit)
- METHODE („GET“, „POST“, „PUT“, „DELETE“, „PATCH“, „HEAD“)
- Assertionsfeld

Warum und wann dieser Vorgang ausgeführt wird

Die SyntheticsAsyncMassenErstellen API verwendet einen zweistufigen Prozess, wenn über Postman darauf zugegriffen wird. Erstellen Sie zuerst eine POST-Anforderung, um Ihre Überwachungsdatendatei hochzuladen und eine Auftrags-ID zu generieren. Verwenden Sie dann die Statusüberprüfungs-URL, um die Monitorerstellung zu überprüfen. Postman bietet eine anwenderfreundliche Oberfläche zum Testen der API und zum Anzeigen formatierter Antworten.

Dieselbe Postman-Konfiguration funktioniert sowohl für JSON- als auch CSV-Dateien, wobei nur die Dateiformatauswahl unterschiedlich ist.

Prozedur

Öffnen Sie die Postman-Anwendung.
Erstellen Sie eine neue Anforderung, indem Sie auswählen + Schaltfläche oder Neu > HTTP-Anforderungan.
Legen Sie die Anforderungsmethode auf fest VERÖFFENTLICHEN Geben Sie im Dropdown-Menü die Basis-URL des API-Endpunkts für Massenimport in das Feld „Anforderungs-URL“ ein.

Ersetzen {Instance-Name} In der Basis-URL mit Ihrem ServiceNow Instanzname.
Konfigurieren Sie Anmeldeinformationen zur Authentifizierung.
1. Wählen Sie aus Autorisierung Registerkarte unter URL Feld.
2. Wählen Sie Aus Standardauthentifizierung Von Typ Dropdownliste.
3. Geben Sie ein ServiceNow Anwendername in Anwendername Feld.
  Stellen Sie sicher, dass dieser Anwender über die Synthetic-Administratorrolle verfügt.
4. Geben Sie Ihr Passwort in ein Passwort Feld.
Konfigurieren Sie den Anforderungstext, um Ihre Überwachungsdatendatei hochzuladen.
1. Wählen Sie die Registerkarte Textkörper aus.
2. Wählen Sie Aus Binär Als Textkörper-Typ.
3. Wählen Sie aus Wählen Sie Datei Aus Schaltfläche, navigieren Sie zum Speicherort der Überwachungsdatendatei, und wählen Sie Ihre JSON- oder CSV-Datei aus.
  Wenn Sie eine CSV-Datei hochladen, stellen Sie sicher, dass sie ordnungsgemäß mit allen erforderlichen Spalten formatiert ist. Konvertieren Sie die CSV-Datei in das JSON-Format
Fügen Sie den Dateinamen als Abfrageparameter in der URL hinzu, und wählen Sie aus Senden Um die Anforderung zu übermitteln.
Beispiel: Wenn Ihr Dateiname „Überwachen“ lautet .JSON, dann ist der Dateipfad https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create?filename=Monitors.JSON

Die API gibt eine JSON-Antwort zurück, die eine Auftrags-ID und eine Statusüberprüfungs-URL enthält.
{ "Ergebnis": { "Job_ID": "Abc123def456", "Status": "Wird verarbeitet", "Status_Check_url": "https://{instance-name}.service-now.com/api/now/synthetic/monitor/bulk/status/abc123def456" } }
Kopieren Sie die Statusprüfungs-URL aus der Antwort.
Erstellen Sie eine neue GET-Anforderung, um den Auftragsstatus zu überprüfen.
1. Klicken Sie in der Antwort auf die Statusüberprüfungs-URL, oder erstellen Sie manuell eine neue Anforderung.
  Wenn auf die URL in Postman geklickt werden kann, wird automatisch eine neue GET-Anforderung mit ausgefüllter URL erstellt.
2. Wenn Sie manuell erstellen, legen Sie die Anforderungsmethode auf fest ABRUFEN .
3. Fügen Sie die Statusprüfungs-URL ein ( https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/{Job_ID} In SS Feld.
  
  Ersetzen Sie {Job_ID} durch die Auftrags-ID aus der POST-Antwort.
Konfigurieren Sie die Authentifizierung für die Statusprüfungsanforderung.
Wenn Sie sich im selben Postman-Arbeitsbereich befinden, ist die Autorisierung möglicherweise bereits geerbt. Wenn nicht, wiederholen Sie die Konfiguration der Standardauthentifizierung aus Schritt 4.

Wählen Sie Aus Senden Dient zum Überprüfen des Auftragsstatus.

Sie können die Anforderungen zur Wiederverwendung in einer Sammlung speichern.

Die API gibt eine der folgenden Statusantworten zurück:

Verarbeitungsstatus:

{
  "result": {
    "job_id": "abc123def456",
    "status": "processing",
    "total_records": 10,
    "processed_records": 3
  }
}

Abschlussstatus (erfolgreich):

{
  "result": {
    "job_id": "abc123def456",
    "status": "complete",
    "total_records": 10,
    "successful_records": 10,
    "failed_records": 0,
    "details": []
  }
}

Status „Abgeschlossen“ (mit Fehlern):

{
  "result": {
    "job_id": "abc123def456",
    "status": "complete",
    "total_records": 10,
    "successful_records": 8,
    "failed_records": 2,
    "details": [
      {
        "name": "Monitor_API_001",
        "status": "failed",
        "error_code": "MISSING_REQUIRED_FIELD",
        "reason": "CMDB CI is required"
      },
      {
        "name": "Monitor_API_002",
        "status": "failed",
        "error_code": "INVALID_REFERENCE",
        "reason": "Location not found for this sys_id"
      }
    ]
  }
}

Wenn der Status „wird verarbeitet“ lautet, warten Sie einige Minuten, und wählen Sie aus Senden Erneut, um den Status zu aktualisieren.
Das System verarbeitet Datensätze asynchron. Fahren Sie mit der Überprüfung fort, bis sich der Status in „Abgeschlossen“ ändert.
Wenn Überwachungen nicht erstellt werden konnten, überprüfen Sie die Fehlerdetails in der Antwort.
1. Erweitern Sie Details Array im Postman-Antwortbetrachter, um einzelne Fehlerdatensätze anzuzeigen.
2. Notieren Sie sich den Überwachungsnamen, den Fehlercode und den Grund für jeden Fehler.
3. Aktualisieren Sie Ihre JSON- oder CSV-Quelldatei, um die identifizierten Probleme zu beheben.
  Häufige Fehler:
  - Fehlende Pflichtfelder (CMDB-CI, Standort, Methode)
  - Ungültige sys_ID-Referenzen, die in der Instanz nicht vorhanden sind
  - Falsche Datenformate oder Feldnamen
4. Kehren Sie zu Ihrer ursprünglichen POST-Anforderung zurück, und übermitteln Sie sie mit der korrigierten Datei erneut.

Ergebnisse

Überwachungen werden in Ihrer ServiceNow-Instanz erstellt. Erfolgreich erstellte Monitore sind sofort zur Verwendung verfügbar. Fehlgeschlagene Überwachungen werden mit bestimmten Fehlerdetails in einem strukturierten JSON-Format gemeldet, das im Antwortbetrachter von Postman einfach überprüft werden kann.

Workflow-Beispiel abschließen

Schritt 1: Konfigurieren Sie DIE POST-Anforderung

Methode: POST
URL: https://myinstance.service-now.com/api/now/synthetic/monitor/bulk/import
Autorisierung: Standardauthentifizierung (Anwendername: administrator, Passwort: *******)
Textkörper: Binär, Datei ausgewählt: Monitor_Data.JSON
Header: Content-Type: Application/JSON, Accept: Application/JSON

Antwort erhalten:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "processing",
    "status_check_url": "https://myinstance.service-now.com/api/now/synthetic/monitor/bulk/status/xyz789abc123"
  }
}

Schritt 2: GET-Anforderung für Statusprüfung konfigurieren

Methode: GET
URL: https://myinstance.service-now.com/api/now/synthetic/monitor/bulk/status/xyz789abc123
Autorisierung: Standardauthentifizierung (vom Arbeitsbereich geerbt)

Endgültige Antwort:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "complete",
    "total_records": 5,
    "successful_records": 5,
    "failed_records": 0
  }
}

Nächste Maßnahme

Speichern Sie Ihre Postman-Anforderungen zur späteren Verwendung und einfachen erneuten Übermittlung in einer Sammlung.
Überprüfen Sie Ihre Monitore in der ServiceNow-UI, indem Sie zu Synthetic Monitoring > Monitors navigieren.
Konfigurieren Sie nach Bedarf zusätzliche Überwachungseinstellungen wie Zeitpläne, Benachrichtigungen und Schwellenwerte.

Konvertieren Sie die CSV-Datei in das JSON-Format

Konvertieren Sie Ihre CSV-Datei in das JSON-Format, um Synthetic-Überwachungen zu erstellen.

CSV-Datei im JSON-Format

Um die CSV-Datei in das JSON-Format zu konvertieren, greifen Sie auf das Terminal zu. Führen Sie je nach Betriebssystem die erforderlichen Befehle aus.

Tabelle : 1. Befehle zum Konvertieren der CSV-Datei in das JSON-Format
Betriebssystem	Curl-Befehle
macOS	jq -RS „{csv_content: .}“ filename.csv
Windows Powershell	Wenn Sie jq verwenden, verwenden Sie den Befehl jq -RS „{csv_content: .}“ filename.csv Wenn Sie nur Powershell verwenden (kein jq installiert), verwenden Sie die folgenden Befehle: $csvContent = Get-Content -Pfad „Synthetic_Checks.csv“ -Rohdaten $JSON = @{ csv_content = $csvContent } \| ConvertTo-JSON $JSON Wenn Sie die Windows-Eingabeaufforderung mit installierter jq verwenden, verwenden Sie den Befehl jq -RS „{csv_content: .}“ filename.csv

Die Ausgabe ist ein CSV-Inhalt im JSON-Format, der auf dem Terminal verfügbar ist. { "Csv_content": "Name,Methode,Beschreibung,Intervall,cmdb_ci,...\n\"Monitors1\",\"GET\",\"CHECK1\",5,..." }

Sobald der Inhalt im JSON-Format verfügbar ist, greifen Sie auf zu Textkörper Registerkarte in Postman, und wählen Sie aus Roh Um den Inhalt im JSON-Format einzufügen und auszuwählen Senden .

Hinweis:

Stellen Sie sicher, dass das ausgewählte Format JSON ist.

Der Antwortstatus stellt die Auftrags-ID und den Status der erstellten Überwachungen bereit. Wenn Fehler gefunden werden, korrigieren Sie die Datei, und führen Sie die gleichen Befehle aus, um die Überwachungserstellung abzuschließen.