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

Allgemeine Einstellungen

Verwenden Sie Allgemeine Einstellungen, um den Engine-Hostnamen und das HTTPS-Zertifikat zu konfigurieren, die Zeit zu synchronisieren, instanzweite Optionen zu ändern und die Konfiguration zu sichern oder wiederherzustellen.

FunktionInstanzweite Einstellungen ändern

Geeignet, wennSie ändern Hostname, TLS, Zeitsynchronisation, Backup oder Wiederherstellung der gesamten Engine – nicht einen einzelnen Medien-Workflow.

Anderes Modul verwenden, wennVerwenden Sie für einzelne Streams, Player, Aufzeichnungen, Routen oder Räume das jeweils zuständige Medienmodul.

1Einstellungen lesen2Werte aktualisieren3Zustand prüfen
POST /api/application/getAppInfo
7 Endpunkte

Voraussetzungen

getAppInfo ist eine öffentliche Lesemethode. Konfigurations-, Zertifikats-, Export- und Importvorgänge erfordern einen gültigen x-access-token. Verwenden Sie ein Administratorkonto und sichern Sie die aktuellen Einstellungen, bevor Sie die Konnektivität ändern oder eine Datenbank importieren.

Funktionen

  • getAppInfo liest Anwendungs- und Instanzinformationen.
  • updateHttpConfig ändert HTTP- und Hostname-Einstellungen.
  • updateSslCertificate installiert oder ersetzt TLS-Material.
  • updateCustomSettings ändert die unterstützten Instanzoptionen.
  • updateNtpConfiguration konfiguriert die Zeitsynchronisation.
  • exportDb und importDb unterstützen die Konfigurationssicherung und -wiederherstellung.

Beispiel-Workflow

  1. Lesen Sie die Anwendungsinformationen und exportieren Sie die aktuelle Datenbank.
  2. Aktualisieren Sie den Hostnamen und die HTTP-Konfiguration.
  3. Installieren Sie das passende TLS-Zertifikat.
  4. Überprüfen Sie das Dashboard und die API auf der endgültigen HTTPS-Adresse.

Typische Anwendungsfälle

  • Verschieben Sie eine Engine-Instanz von einer IP-Adresse zu einem Produktionshostnamen.
  • Erneuern Sie ein auslaufendes TLS-Zertifikat, ohne Medien-Workflows neu zu erstellen.
  • Sichern Sie die Konfiguration vor einem Upgrade oder einer Infrastrukturänderung.

Einschränkungen und Fehlerbehebung

Ein falscher Hostname, ein fehlerhaftes Zertifikat oder eine ungeeignete HTTP-Konfiguration kann die Instanz unerreichbar machen. Ein Datenbankimport kann die vorhandene Konfiguration ersetzen; prüfen Sie deshalb zuerst das Backup und planen Sie ein Wartungsfenster ein. Halten Sie die Systemzeit synchron, da Zertifikate, Token und verteilte Workflows davon abhängen.

Nächste Schritte

Sobald die Verbindung stabil ist, konfigurieren Sie Ports, Cluster-Knoten oder das für den Workflow benötigte Ingest-Modul.

REST-Lösungsrezept

HTTP- und TLS-Grenze der Engine konfigurieren

Lesen Sie die Anwendungseinstellungen, wählen Sie den benötigten HTTP-Modus und installieren Sie das Zertifikat für API- und Mediendienste.

  1. Aktuelle Einstellungen lesenErfassen Sie Modus und Anwendungsstatus vor einer Listener-Änderung.POST /api/application/getAppInfo
  2. HTTP-Modus setzenWenden Sie die geprüfte HTTP- oder HTTPS-Listener-Konfiguration an.POST /api/application/updateHTTPConfig
  3. Zertifikat installierenAktualisieren Sie das Zertifikat erst nach Prüfung von Namen und Kette.POST /api/application/updateSSLCertificate

HTTP- oder Zertifikatsänderungen können aktive Clients unterbrechen. Prüfen Sie DNS, Zertifikatskette, Ports und Rollback-Zugriff.

POST
/api/application/getAppInfo
Öffentlicher Endpunkt

Rufen Sie mit dieser öffentlichen Methode die Anwendungsdaten von Callaba Engine ab, bevor Sie instanzweite Änderungen vornehmen. Ein API-Token ist dafür nicht erforderlich.

Die Antwort enthält node_app, stack_version_name, stack_version, custom_settings, http_modes, needLicenceKey, Konferenz-URLs unter global_module_settings und read_preference.

Das Erfolgsfeld heißt tatsächlich suceess. Clients müssen genau diesen Feldnamen aus der Antwort auslesen.

Parameter im Request-Body
Diese Methode hat keine Parameter
Anwendungsinformationen abrufen
Code kopieren
curl --request POST \
  --url http://localhost/api/application/getAppInfo \
  --header 'Content-Type: application/json' \
  --data '{}'
Antwort
Versionierung
node_app / stack_version_name / stack_version
mixed
Direktlink kopieren

Aktuelle Bereitstellungsvariante und Stack-Version aus Anwendungsdatensatz und Umgebung.

Lieferung
http_modes
array
Direktlink kopieren

Aktuelle HTTP-Auslieferungsmodi, die im Anwendungsdatensatz gespeichert sind.

Benutzerdefinierte Einstellungen
custom_settings
object
Direktlink kopieren

Persistente benutzerdefinierte Anwendungseinstellungen.

Lizenzierung
needLicenceKey
boolean
Direktlink kopieren

Gibt an, ob der Anwendungseintrag derzeit keinen Lizenzschlüssel hat.

Videoanrufe
global_module_settings.MODULE_CONFERENCES
object
Direktlink kopieren

Aktuelle wss_server_url und turn_server_url Werte für Konferenzkonnektivität.

Datenbank
read_preference
string
Direktlink kopieren

Aufgelöste Datenbanklesepräferenz; das Backend fällt auf seine Primärlesekonstante zurück.

Betriebsergebnis
suceess
boolean
Direktlink kopieren

Das Live-Backend gibt derzeit dieses falsch geschriebene Feld mit dem Wert true zurück.

Antwort: Anwendungsinformationen abrufen
JSON
Code kopieren
{
  "node_app": "NODE_APP_SELF_HOSTED",
  "stack_version_name": "stable",
  "stack_version": "8.2",
  "custom_settings": {
    "showBrandName": false,
    "useCustomLogo": true
  },
  "http_modes": [
    {
      "mode": "HTTPS"
    },
    {
      "mode": "HTTP"
    }
  ],
  "needLicenceKey": false,
  "global_module_settings": {
    "MODULE_CONFERENCES": {
      "wss_server_url": "wss://video.example.com:443",
      "turn_server_url": "turn:turn.example.com:3478"
    }
  },
  "read_preference": "primary",
  "suceess": true
}
POST
/api/application/updateHTTPConfig
API-Token erforderlich
POST
/api/application/updateSSLCertificate
API-Token erforderlich
POST
/api/application/updateCustomSettings
API-Token erforderlich
POST
/api/application/importDb
API-Token erforderlich
POST
/api/application/exportDb
API-Token erforderlich
POST
/api/application/updateNTPConfiguration
API-Token erforderlich
Weiter zuPorts