API Protokollseite im Jitterbit API-Manager

Einführung

Auf der Seite API Protokolle im API-Manager wird eine Tabelle aller API Verarbeitungsprotokolle sowie debuggen (sofern die debuggen aktiviert ist) angezeigt. Protokolle werden für benutzerdefinierte, OData und Proxy APIs angezeigt, wenn sie über das Cloud API Gateway aufgerufen werden. oder privates API Gateway.

Es gibt vier Arten von Protokollen, die für einen API Aufruf aufgezeichnet werden können:

• API Protokolle: API Protokolle werden automatisch auf der Seite API Protokolle für jeden API -Aufruf des API-Manager generiert. API Protokolle enthalten Informationen zum API -Aufruf, einschließlich des Zeitstempels der API Anforderung, des HTTP-Statuscodes, der Anforderungs-ID, der Anforderungsmethode, der Anforderungs-URI, der Antwortzeit, der Quell-IP der aufrufenden Anwendung, der Quellanwendung und aller Protokollnachrichten.
• API -Debugprotokolle: API debuggen sind zusätzliche Einträge in einem vorhandenen API Protokoll, die jede über die Service URL einer API-Manager-API empfangene Anfrage vollständig nachverfolgen. Die API debuggen ist standardmäßig nicht aktiviert und muss für eine einzelne API-Manager API aktiviert werden, damit API debuggen in ein API Protokoll aufgenommen werden.
• Ausführliche API Protokolle: Ausführliche API Protokolle sind zusätzliche Einträge in einem vorhandenen API Protokoll, die aus Anforderungs- und Antwortdaten bestehen, die über die Service URL einer API-Manager API empfangen oder gesendet werden. Die ausführliche API Protokollierung ist standardmäßig nicht aktiviert und muss für eine einzelne API-Manager API aktiviert werden, damit ausführliche API -Protokolle in ein API -Protokoll aufgenommen werden.
• API -Operationsprotokolle: API Operation enthalten den Beginn eines API Aufrufs und die verstrichene Zeit. Im Gegensatz zu API Protokollen, debuggen Protokollen und ausführlichen Protokollen erfordern API Operation die Verwendung eines privaten Agenten und werden in der privaten Agentenkonfigurationsdatei aktiviert. Diese Protokolle werden auf dem privaten Agenten im jitterbit.log Datei im log Verzeichnis.

Protokollierungsdaten für API -Protokolle, debuggen-Protokolle und ausführliche Protokolle sind auf der Seite API Protokolle 90 Tage lang ab dem Datum der Nutzung der API verfügbar.

Weitere Informationen zum Aktivieren von debuggen Protokollen und ausführlichen Protokollen finden Sie in diesen Ressourcen:

• Schritt 1: Einstellungen von benutzerdefinierter API Konfiguration
• Schritt 1: Einstellungen von OData Dienstkonfiguration
• Schritt 1: Grundeinstellungen von Proxy-API Konfiguration

So fügen Sie zusätzliche Protokollinformationen für OData APIs hinzu, einschließlich der an die Datenbank gesendeten SQL-Daten, bearbeiten Sie die private Agent-Konfigurationsdatei und setzen Sie DebugJDML Zu true.

Zugriff auf die Seite „API Protokolle“

Um auf die Seite API Protokolle zuzugreifen, wählen Sie im Harmony-Portalmenü API-Manager > API Protokolle aus:

Header der Seite „API Protokolle“

Die Header oben auf der Seite API Protokolle enthält eine Suchleiste, Filter und zusätzliche Optionen:

Sie können die angezeigten Daten mithilfe der Dropdown-Menüs Filtern nach und Daten anzeigen anpassen.

Filtern nach

Mit den Dropdown-Menüs Filtern nach können Sie API Protokolle basierend auf bestimmten Kriterien für beliebige Kombinationen von Umgebungen, APIs, Profilen, Statuscodes oder Anforderungsmethoden anzeigen.

Jeder Filter zeigt eine Dropdown-Liste mit Kriterien an, aus der Sie ein oder mehrere Kriterien auswählen können.

Zum Filtern stehen folgende Kriterien zur Verfügung:

• Umgebungen: Verwenden Sie das Dropdown-Menü, um Umgebungen auszuwählen, in denen sich die APIs befinden. Wenn alle Filter deaktiviert sind, werden Umgebungen für alle APIs in der Organisation angezeigt, auf die Sie Zugriff haben.

• APIs: Verwenden Sie das Dropdown-Menü, um veröffentlichte APIs innerhalb der Organisation auszuwählen. Wenn alle Filter deaktiviert sind, werden alle APIs in der Organisation angezeigt, auf die Sie Zugriff haben.

  Notiz

  Zuvor veröffentlichte APIs, deren Veröffentlichung aufgehoben wird, werden nicht in der Dropdown-Liste „APIs“ angezeigt. API Protokolle für diese APIs sind auf der Seite „API -Protokolle“ vorhanden, können aber nicht gefiltert werden.

• Profile: Verwenden Sie das Dropdown-Menü, um die zugewiesenen Sicherheitsprofile der APIs auszuwählen. Wenn alle Filter deaktiviert sind, werden alle Sicherheitsprofile in der Organisation angezeigt, auf die Sie Zugriff haben.

• Statuscodes: Verwenden Sie das Dropdown-Menü, um die HTTP-Antwortstatuscodegruppen auszuwählen. Wählen Sie aus Erfolg (2xx), Umleitungen (3xx), Clientfehler (4xx) und Serverfehler (5xx). Wenn alle Filter deaktiviert sind, werden alle HTTP-Antwortstatuscodes für APIs in den Organisationen angezeigt, auf die Sie Zugriff haben. Weitere Informationen zu Statuscodes finden Sie unter w3.org-Statuscodedefinitionen.

• Anforderungsmethoden: Verwenden Sie das Dropdown-Menü, um die HTTP-Anforderungsmethoden auszuwählen. Wählen Sie aus GET, PUT, POST, DELETE, PATCH und MERGE. Wenn alle Filter deaktiviert sind, werden alle HTTP-Anforderungsmethoden für APIs in der Organisation angezeigt, auf die Sie Zugriff haben. Weitere Informationen zu HTTP-Anforderungsmethoden finden Sie unter w3.org-Anforderungsmethoden.

• API-Gateway: Nur sichtbar, wenn eine Organisation zwei oder mehr Cloud-API Gateways verwendet. Verwenden Sie das Menü, um die Cloud API Gateway-Domäne auszuwählen. In der Tabelle API Protokolle werden nur Protokolle für die ausgewählte Domäne angezeigt.

Daten anzeigen

Mit der Option Daten anzeigen können Sie Protokolle innerhalb eines bestimmten Zeitraums anzeigen. Die Standardeinstellung für den Zeitraum ist Letzte 7 Tage.

Wählen Sie über das Dropdown-Menü Daten anzeigen den gewünschten Zeitraum aus. Wählen Sie eine der folgenden Optionen aus: Letzte 10 Minuten, Letzte 1 Stunde, Letzte 10 Stunden, Letzte 24 Stunden, Letzte 7 Tage, Letzter 1 Monat oder Benutzerdefinierter Zeitraum.

Wenn Sie Benutzerdefinierter Zeitraum auswählen, können Sie API Protokolle innerhalb eines angegebenen Zeitraums innerhalb der letzten 90 Tage anzeigen. Wenn diese Option ausgewählt ist, werden zusätzliche Kalenderfelder Von und Bis angezeigt:

• Von: Klicken Sie, um das Startdatum und die Startzeit für die API Protokolle anzupassen.
• An: Klicken Sie, um das Enddatum und die Endzeit für die API Protokolle anzupassen.

Nach dem Anklicken der Kalenderfelder Von oder Bis wird ein Kalenderdialog angezeigt, in dem Sie Datum und Uhrzeit auswählen:

Suchen

Mit der Suchleiste können Sie die Protokolle nach den unten angegebenen Suchkriterien filtern:

• Nur Protokolle mit Nachrichten: Wählen Sie diese Option aus, um die Suchergebnisse weiter auf Protokolle einzuschränken, die Protokollierungsdetails enthalten. Die Suchergebnisse werden automatisch aktualisiert.

Suchkriterien

Dies sind die Suchkriterien, die verwendet werden können. Beispiele für gültige und ungültige Suchkriterien sind enthalten:

Suchen kombinieren

Suchen können eine Kombination von Kriterien enthalten. Kombinierte Suchkriterien müssen durch ein Semikolon (;) zwischen jedem Kriterium. Dies sind Beispiele für gültige kombinierte Suchen:

message=%Access Denied%;requesturi=%contacts%;

requestid=%yzaccwui%;message=%REJECT%;
requesturi=%contacts%;responsetime<=2;
responsetime>=5;sourceapp=%Chrome%;
responsetime>=5;sourceip=70.5%;
sourceapp=%Chrome%;message=%REJECT%;

sourceapp=%Mozilla%;responsetime<=1;

sourceip=70.5%;requesturi=%contacts%;

Zusätzliche Optionen

Zusätzliche API Protokolloptionen werden auf der linken Seite der Seite direkt über der Suchleiste angezeigt:

• Letzte Aktualisierung anzeigen: Zeigt den letzten Zeitpunkt an, zu dem die Daten entweder dynamisch oder manuell aktualisiert wurden. Die Zeit wird im Format angezeigt h:mm:ss.

• Aktualisieren: Klicken Sie hier, um die Protokolldaten basierend auf den angewendeten Filtern und Suchkriterien zu aktualisieren.

• Als CSV herunterladen: Klicken Sie hier, um die aktuellen Protokolldaten basierend auf den angewendeten Filtern und Suchkriterien herunterzuladen.

  Hinweis

  Das Datumsfeld in der CSV-Datei ist ein UNIX-Zeitstempel, der konvertiert werden muss, wenn Sie ein anderes Datums- und Zeitformat verwenden möchten.

API Protokolle anzeigen

Jede Zeile in der Tabelle API Protokolle zeigt API Protokolldaten für einen API Aufruf an:

• Zeitstempel: Der Zeitstempel der API -Anfrage. Die Zeiten werden in der Zeitzone Ihres Browsers angezeigt.
• Statuscode: Der HTTP-Statuscode. Weitere Informationen zu HTTP-Statuscodes finden Sie unter w3.org-Statuscodedefinitionen.
• Anforderungs-ID: Eine eindeutige ID für die API Anforderung.
• Anforderungsmethode: Die HTTP-Anforderungsmethode der API (GET, PUT, POST, DELETE, PATCH oder MERGE).
• Anforderungs-URI: Die vollständige URL der aufgerufenen API. Bewegen Sie den Mauszeiger über das Feld Anforderungs-URI, um die vollständige URL anzuzeigen.
• Reaktionszeit: Die Zeit in Millisekunden, die die Ausführung der API benötigt hat.
• Quell-IP: Die externe IP-Adresse der Anwendung oder des Servers, der die API aufgerufen hat.
• Quellanwendung: Die Quellanwendung für den API Aufruf, nur vorhanden, wenn der API Aufruf in einem Header übergeben wird. Bewegen Sie den Mauszeiger über die Spalte Quellanwendung, um den Inhalt des Felds anzuzeigen.

Auf jeder Seite werden 20 Protokolle angezeigt. Mit den Schaltflächen Weiter und Zurück können Sie alle Protokolle innerhalb der Filter- und Suchkriterien anzeigen.

Anzeigen der Protokolldetails

Um zusätzliche Protokolldetails oder debuggen (falls aktiviert) anzuzeigen, klicken Sie auf das Symbol für die Erweiterung eines Protokolleintrags:

Ein typisches API Protokoll enthält folgende Details:

• Domänenname, Servicepfad und Basis URL der Harmony-Region (siehe API Service-URL)
• Verarbeitungszeit des API Aufrufs
• Sicherheitsprofilinformationen wie Autorisierungstyp und verwendete Anmeldeinformationen
• Payload-Details, einschließlich Länge der Payload und Antwortgröße
• Fehlerinformationen (sofern zutreffend)
• Debug-Protokolle (falls aktiviert)
• Ausführliche Protokolle (falls aktiviert)

Wenn die debuggen für eine API aktiviert ist und die API Payload mehr als 10.000 Zeichen enthält, wird für den Protokolleintrag eine Schaltfläche Nutzlast herunterladen angezeigt. Wenn Sie darauf klicken, wird eine ZIP-Datei der API Payload auf Ihren lokalen Computer heruntergeladen.

API-Manager Log Service API (Beta)

Alternativ zum Herunterladen einer API Protokolldatei durch Klicken auf Als CSV herunterladen können Sie eine API Protokolldatei auch mithilfe einer REST API abrufen. Dazu müssen Sie entweder Befehlszeilenprogramme wie curl oder Anwendungen wie Postman verwenden.

Um die API-Manager Log Service API (Beta) zu verwenden, müssen Sie nach dem Aktivieren der API -Protokolle für die API-Manager API (weiter oben auf dieser Seite beschrieben) führen Sie die folgenden Schritte aus:

1. Rufen Sie mithilfe der User Service Controller API ein Authentifizierungstoken ab. Dieses Token ist erforderlich, um die API-Manager Log Service API (Beta) verwenden zu können.

   • Wenn Ihre Harmony Organisation hat keine Zwei-Faktor-Authentifizierung (TFA) aktiviert, rufen Sie Ihr Authentifizierungstoken mit einer Standard-Anmeldeanforderung ab.

   • Wenn Ihre Harmony Organisation hat TFA aktiviert, Abrufen des Authentifizierungstokens erfordert zwei Anfragen:

     1. TFA-Code abrufen

     2. Verwenden Sie den TFA-Code, um ein Authentifizierungstoken abzurufen

2. Protokolldatei abrufen mithilfe der API-Manager Log Service API (Beta).

Abrufen eines Authentifizierungstokens

Zum Abrufen eines Authentifizierungstokens ist die Verwendung der User Service Controller API erforderlich.

Eine Beispielanforderung, die die Anmeldung bei der NA -Region und das Abrufen des Autorisierungstokens zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!"
}'

Basis URL

Die Basis URL hängt von der Region ab, in der sich die Organisation befindet:

Überschriften

Diese Header sind erforderlich:

Körperparameter

Die folgenden erforderlichen Parameter werden im Hauptteil der Anfrage übergeben:

Antworttext

Der zurückgegebene Antworttext enthält neben dem Authentifizierungstoken (eine Liste der Organisationen, mit denen der Benutzer verbunden ist "authenticationToken"). Dieses Token ist für die nachfolgende Autorisierung mit der API-Manager Log Service API (Beta) erforderlich. In diesem Beispiel lautet das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4" Die Organisations-ID wird angezeigt als "123456" für die erste Organisation, zu der dieser Benutzer gehört. Ein Beispiel für die Antwort:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "20970",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

Abrufen eines Authentifizierungstokens mit aktiviertem TFA

Wenn die Harmony Organisation eines Benutzers die Zwei-Faktor-Authentifizierung (TFA) aktiviert hat, sind zum Abrufen des Authentifizierungstokens zwei Anfragen über die User Service Controller API erforderlich:

1. TFA-Code abrufen

2. Verwenden Sie den TFA-Code, um ein Authentifizierungstoken abzurufen

Einen TFA-Code abrufen

Ein gültiger TFA-Code ist erforderlich, um ein Authentifizierungstoken abzurufen, wenn TFA aktiviert ist. Eine Beispielanforderung zeigt die Anmeldung bei der NA Region und die Anforderung eines TFA-Codes:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "deviceId": "abcd"
}'

Basis URL

Die Basis URL hängt von der Region ab, in der sich die Organisation befindet:

Überschriften

Diese Header sind erforderlich:

Körperparameter

Die folgenden erforderlichen Parameter werden im Hauptteil der Anfrage übergeben:

Antworttext

Der zurückgegebene Antworttext enthält eine Fehlermeldung, die angibt, dass ein TFA-Code an die Email Adresse des Benutzers gesendet wurde.

{
  "status": false,
  "operation": "User login",
  "errorCode": "VALIDATE_TFA_LOGIN_EMAIL",
  "errorMessage": "Validate your login with authentication code. An email from Jitterbit with the code was sent to you.",
  "authenticationToken": null,
  "serverUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [],
  "defaultOrgId": null
}

Verwenden des TFA-Codes zum Abrufen eines Authentifizierungstokens

Der an die Email-Adresse des Benutzers gesendete TFA-Code kann nun in der zweiten Anfrage verwendet werden, um das Authentifizierungstoken abzurufen. Eine Beispielanfrage, die die Anmeldung in der NA -Region mit einem TFA-Code und das Abrufen des Autorisierungstokens zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login/code' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "code": "112233"
    "deviceId": "abcd"
}'

Basis URL

Die Basis URL hängt von der Region ab, in der sich die Organisation befindet:

Überschriften

Diese Header sind erforderlich:

Körperparameter

Die folgenden erforderlichen Parameter werden im Hauptteil der Anfrage übergeben:

Antworttext

Der zurückgegebene Antworttext enthält neben dem Authentifizierungstoken (eine Liste der Organisationen, mit denen der Benutzer verbunden ist "authenticationToken"). Dieses Token ist für die nachfolgende Autorisierung mit der API-Manager Log Service API (Beta) erforderlich. In diesem Beispiel lautet das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4" Die Organisations-ID wird angezeigt als "123456" für die erste Organisation, zu der dieser Benutzer gehört. Ein Beispiel für die Antwort:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "654321",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

API Protokolle asynchron abrufen (Beta)

Sobald Sie über das Authentifizierungstoken und die Organisations-ID verfügen, können Sie API Protokolle asynchron mithilfe der API-Manager Log Service API (Beta) abrufen. Ein Beispiel, das das Abrufen aller Datensätze vom 20. Januar 2023 bis zum 20. Januar 2024 zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/api/analytics/debuglogs-async' \
--header 'Content-Type: application/json' --header 'Accept: application/json' --header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4' \
--data-raw '{
    "ascendSort": false,
    "retrieveLogMessages": false,
    "timeRangeFrom": "01/20/2023 01:01:00 +0100",
    "timeRangeTo": "01/20/2024 01:01:00 +0100",
    "clientTimeZone": "Europe/Berlin",
    "queryString": "responsetime>5; sourceip=14.141%",
    "orgId": "123456",
    "csvFormat": true
}'

Basis URL

Die Basis URL hängt von der Region ab, in der sich die Organisation befindet:

Überschriften

Diese Header können in der Anfrage verwendet werden:

Körperparameter

Die folgenden Parameter können im Textkörper der Anfrage übergeben werden:

Antworttext

Bei Erfolg enthält der zurückgegebene Antworttext einen Referenzschlüssel zum Verfolgen und Herunterladen der API Protokolldatei basierend auf den angegebenen Parametern:

{
    "key": "debug-log-E8D47FE1F172D3EE46C620791E614B78D111CE624485D2E1B3D482370690DC40",
    "status": "COMPLETE"
}

Der Referenzschlüssel kann dann als Teil des folgenden API Aufrufs bereitgestellt werden, um den Status der Protokolldatei zu überprüfen oder sie herunterzuladen, wenn der Status ABGESCHLOSSEN ist:

curl --location --request GET 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/api/analytics/log-async/{orgId}/{key}' \
--header 'Content-Type: application/json' --header 'Accept: application/json' --header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4'

Mögliche Status sind:

• ERHALTEN: Harmony hat eine gültige Anfrage zum Generieren der Protokolldatei erhalten. Der Status wechselt zu VERARBEITUNG, wenn die Anfrage ausgeführt wird.
• VERARBEITUNG: Die Protokolldatei wird generiert. Der Status wechselt zu ABGESCHLOSSEN, wenn die Dateigenerierung abgeschlossen ist.
• ABGESCHLOSSEN: Die Protokolldatei ist nun zum Download bereit log-async API oben.
• UNGÜLTIG: Der Referenzschlüssel konnte nicht gefunden werden. Dieser Status wird nur gemeldet, wenn ein unbekannter oder fehlerhafter Referenzschlüssel an den log-async API.
• FEHLER: Der Referenzschlüssel wurde gefunden, nachdem die API versucht hatte, die Protokolldatei zu generieren, aber es wurde ein Fehler gemeldet. Außerdem wird eine Fehlermeldung zurückgegeben, die detailliert beschreibt, warum die Generierung fehlgeschlagen ist.
• NO_DATA: Die Filterparameter, die Daten im ursprünglichen API Aufruf abfragten, haben 0 Ergebnisse zurückgegeben.