Log API

Übersicht

Die Log API dient zum Anzeigen und Herunterladen von Protokolldateien in Fess. Sie können die auf dem Server ausgegebenen Protokolldateien auflisten und einzelne Protokolldateien herunterladen.

Basis-URL

/api/admin/log

Authentifizierung

Wie bei anderen Admin-APIs ist eine Authentifizierung über ein Zugriffstoken erforderlich. Das Zugriffstoken benötigt die Berechtigung Radmin-api (konfiguriert über api.admin.access.permissions, Standardwert: Radmin-api). Das Zugriffstoken wird im Anfrage-Header angegeben.

Authorization: Bearer <Zugriffstoken>

Weitere Informationen zur Authentifizierung und zum Abrufen von Zugriffstoken finden Sie unter Admin API Übersicht.

Endpunktliste

Methode Pfad Beschreibung
GET /files Protokolldateien auflisten
GET /file/{id} Protokolldatei herunterladen

Protokolldateien auflisten

Gibt eine Liste der im Protokollausgabeverzeichnis des Servers vorhandenen Protokolldateien (.log und .log.gz) zurück. Die Dateien werden in aufsteigender Reihenfolge nach Dateinamen sortiert zurückgegeben.

Request

GET /api/admin/log/files

Response

In files wird ein Array von Objekten gespeichert, die die Informationen der einzelnen Protokolldateien darstellen, und in total die Anzahl. Jedes Objekt hat die folgenden Felder.

Feld Beschreibung
id Base64-URL-codierter Wert des Dateinamens (wird beim Herunterladen als {id} verwendet)
name Name der Protokolldatei
lastModified Zeitpunkt der letzten Änderung 
{
  "response": {
    "version": "15.7.0",
    "status": 0,
    "files": [
      {
        "id": "ZmVzcy5sb2c=",
        "name": "fess.log",
        "lastModified": "2025-01-01T00:00:00.000+00:00"
      },
      {
        "id": "ZmVzcy1jcmF3bGVyLmxvZw==",
        "name": "fess-crawler.log",
        "lastModified": "2025-01-01T00:00:00.000+00:00"
      }
    ],
    "total": 2
  }
}

Bemerkung

version enthält die Produktversion der laufenden Fess-Instanz. Der Inhalt und die Anzahl von files hängen von den auf dem Server vorhandenen Protokolldateien ab; das obige ist daher nur ein Beispiel.

Protokolldatei herunterladen

Lädt den Inhalt der angegebenen Protokolldatei herunter. Für {id} wird die beim Auflisten erhaltene id (der mit Base64-URL-Kodierung codierte Dateiname) unverändert angegeben. Die Antwort wird als Stream vom Typ application/octet-stream zurückgegeben. Aus Sicherheitsgründen werden nur Namen akzeptiert, die auf .log oder .log.gz enden; Namen mit Pfadmanipulationssequenzen wie .. werden abgelehnt. Wird ein nicht existierender Dateiname oder ein als Protokolldatei nicht zulässiger Name angegeben, wird eine leere Antwort zurückgegeben.

Request

GET /api/admin/log/file/{id}

Response

Binärer Stream der Protokolldatei (Content-Type: application/octet-stream).

Verwendungsbeispiele

Protokolldateien auflisten

curl -X GET "http://localhost:8080/api/admin/log/files" \
     -H "Authorization: Bearer YOUR_TOKEN"

Protokolldatei herunterladen

curl -X GET "http://localhost:8080/api/admin/log/file/ZmVzcy5sb2c=" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -o fess.log

Referenzinformationen