media server logo
PreiseAnmeldenAuf AWS startenEmpfohlene Region: Frankfurt.
API-DokumentationÜbersicht
Allgemeine Einstellungen
Ports
Cluster-Knoten
Zusätzliche Dienstprogramme
Speicherziele
Dokumentationsnavigation ein- oder ausblenden
Callaba-Startseite

Zusätzliche Dienstprogramme

Verwenden Sie die zusätzlichen Dienstprogramme, um den Zustand der Instanz zu prüfen, den Netzwerkdurchsatz zu messen, den Standort einer IP-Adresse abzufragen und gesammelte Fehlerprotokolle zu löschen.

FunktionBetriebszustand prüfen

Geeignet, wennSie benötigen Host-Statistiken, Bandbreitenmessung, IP-Standort oder eine Fehlerprotokoll-Diagnose.

Anderes Modul verwenden, wennVerwenden Sie die Statistiken des zuständigen Medienmoduls, wenn die Frage einen bestimmten Stream oder Prozess betrifft.

1Werkzeug auswählen2Prüfung ausführen3Ergebnis auswerten
POST /api/utils/getStat
4 Endpunkte

Voraussetzungen

getLocation ist eine öffentliche Lesemethode. Statistiken, Bandbreitentests und die Protokollbereinigung erfordern einen gültigen x-access-token. Führen Sie Tests und Bereinigungen nur mit vertrauenswürdigen Betriebswerkzeugen aus, da sie Ressourcen beanspruchen oder wichtige Diagnosedaten löschen können.

Funktionen

  • getStat liest verfügbare Instanzstatistiken.
  • speedTest misst den Netzwerkdurchsatz der Instanz.
  • getLocation gibt den erkannten Instanzstandort zurück.
  • clearErrorLogs löscht akkumulierte Fehlerprotokolle.

Beispiel-Workflow

  1. Lesen Sie aktuelle Statistiken, bevor Sie den Workload ändern.
  2. Führen Sie einen Geschwindigkeitstest außerhalb des Live-Produktionsfensters durch.
  3. Vergleichen Sie das Ergebnis mit der erwarteten Ingest- und Egress-Bitrate.
  4. Exportieren Sie benötigte Daten zur Störungsanalyse, bevor Sie Protokolle löschen.

Typische Anwendungsfälle

  • Prüfen Sie einen neuen regionalen Host, bevor Sie eine Live-Veranstaltung dorthin routen.
  • Untersuchen Sie, ob unzureichende Netzwerkkapazität instabile Streams verursacht.
  • Bestätigen Sie die erkannte Region, bevor Sie Kunden-Workloads zuweisen.

Einschränkungen und Fehlerbehebung

Ein Geschwindigkeitstest misst den aktuellen Netzwerkpfad und kann Live-Traffic beeinträchtigen; das Ergebnis ist keine garantierte Kapazitätsangabe. Der Standort dient als betrieblicher Hinweis und nicht als präzise physische Geolokalisierung. Das Löschen von Protokollen ist endgültig. Sichern Sie deshalb zuerst alle Daten, die der Support oder die Störungsanalyse benötigt.

Nächste Schritte

Verwenden Sie das Ergebnis, um die Bereitstellungskapazität, die Netzwerkrichtlinie oder das betroffene Medienmodul anzupassen.

REST-Lösungsrezept

Das Instanznetz vor einem Live-Event prüfen

Ermitteln Sie das öffentliche Standortsignal und führen Sie einen Geschwindigkeitstest als Teil der Deployment-Prüfung vor Live-Quellen durch.

  1. Öffentlichen Standort prüfenNutzen Sie die Adressdaten, um eine unerwartete Deployment-Region zu erkennen.POST /api/utils/getLocation
  2. Preflight-Test ausführenDokumentieren Sie das Ergebnis zusammen mit dem realen SRT- oder RTMP-Pfadtest.POST /api/utils/speedTest

Ein Geschwindigkeitstest ist eine Momentaufnahme, keine Kapazitätsgarantie. Prüfen Sie Durchsatz, Paketverlust, Latenz und den realen Medienpfad.

POST
/api/utils/getStat
API-Token erforderlich

Rufen Sie mit dieser Methode eine kompakte Zustandsübersicht der Instanz ab. Sie zeigt CPU-, RAM- und Festplattenauslastung, öffentlich verfügbare Versionsinformationen sowie gesammelte Prozess- und SRT-Fehler, bevor Sie mit der modulspezifischen Fehlersuche beginnen.

Parameter im Request-Body
Diese Methode hat keine Parameter
Instanzstatistiken abrufen
Code kopieren
curl --request POST \
  --url http://localhost/api/utils/getStat \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Antwort
Systemzustand
cpuUsage / drive / RAM
mixed
Direktlink kopieren

Momentaufnahme von CPU-Auslastung, Festplatte und Arbeitsspeicher des Engine-Hosts.

Versionierung
publicVersion
array
Direktlink kopieren

Metadaten der veröffentlichten Version, die vom Dashboard verwendet werden, um den lokalen Build mit verfügbaren öffentlichen Versionen zu vergleichen.

Fehlerdiagnose
srtErrors / processErrors
array
Direktlink kopieren

Gesammelte SRT- und Prozessfehlerdaten, die Operatoren vor dem Zurücksetzen prüfen können.

Betriebsergebnis
success
boolean
Direktlink kopieren

Erfolgreiche Antworten zeigen success: true.

Antwort: Instanzstatistiken abrufen
JSON
Code kopieren
{
  "cpuUsage": 12.4,
  "drive": {
    "totalGb": "250.00",
    "usedGb": "81.00",
    "usedPercentage": "32.4"
  },
  "RAM": {
    "totalMemMb": 16384,
    "usedMemMb": 6240,
    "usedMemPercentage": 38.1
  },
  "publicVersion": [
    {
      "version_name": "stable",
      "version_number": "8.2"
    }
  ],
  "srtErrors": [],
  "processErrors": [],
  "success": true
}
POST
/api/utils/speedTest
API-Token erforderlich
POST
/api/utils/clearErrorLogs
API-Token erforderlich
POST
/api/utils/getLocation
Öffentlicher Endpunkt
Zurück zuCluster-KnotenWeiter zuCallaba Engine-Dokumentation