media server logo
Mostrar u ocultar la navegación
Inicio de Callaba

Ajustes generales

Usa Ajustes generales para configurar el nombre de host y el certificado HTTPS de Engine, sincronizar la hora, cambiar opciones de toda la instancia y crear o restaurar copias de seguridad de la configuración.

Qué haceAplicar ajustes de toda la instancia

Elige este módulo cuandoVas a cambiar hostname, TLS, hora, copia de seguridad o restauración, no un único flujo multimedia.

Usa otro módulo cuandoUsa el módulo multimedia correspondiente para un stream, reproductor, grabación, ruta o sala concretos.

1Consulta los ajustes2Actualiza los valores3Comprueba el estado
POST /api/application/getAppInfo
7 endpoints

Antes de empezar

getAppInfo es un método público de lectura. Las operaciones de configuración, certificados, exportación e importación requieren un x-access-token válido. Usa una cuenta con responsabilidad administrativa sobre la instancia y guarda una copia de la configuración actual antes de cambiar la conectividad o importar una base de datos.

Qué puedes hacer

  • getAppInfo consulta información de la aplicación y la instancia.
  • updateHttpConfig modifica los ajustes HTTP y el nombre de host.
  • updateSslCertificate instala o sustituye el material TLS.
  • updateCustomSettings cambia las opciones compatibles de la instancia.
  • updateNtpConfiguration configura la sincronización horaria.
  • exportDb e importDb permiten crear y restaurar copias de seguridad de la configuración.

Flujo de ejemplo

  1. Consulta la información de la aplicación y exporta la base de datos actual.
  2. Actualiza el nombre de host y la configuración HTTP.
  3. Instala el certificado TLS correspondiente.
  4. Comprueba el panel y la API en la dirección HTTPS definitiva.

Casos de uso habituales

  • Migrar una instancia de Engine desde una dirección IP a un nombre de host de producción.
  • Rotar un certificado TLS próximo a caducar sin reconstruir los flujos multimedia.
  • Guardar la configuración antes de una actualización o un cambio de infraestructura.

Límites y resolución de problemas

Un nombre de host, certificado o ajuste HTTP incorrecto puede dejar la instancia inaccesible. La importación de la base de datos puede sustituir la configuración existente: valida primero la copia y la ventana de mantenimiento. Mantén sincronizada la hora del sistema, ya que los certificados, tokens y flujos distribuidos dependen de ella.

Siguientes pasos

Cuando la conectividad sea estable, configura Puertos, Nodos del clúster o el módulo de ingesta que necesite el flujo.

Receta de solución REST

Configurar el límite HTTP y TLS de Engine

Consulta la configuración, elige el modo HTTP necesario e instala el certificado usado por la API y los servicios de medios.

  1. Consultar la configuraciónGuarda el modo y estado actuales antes de cambiar el listener.POST /api/application/getAppInfo
  2. Definir el modo HTTPAplica la configuración revisada del listener HTTP o HTTPS.POST /api/application/updateHTTPConfig
  3. Instalar el certificadoActualiza el certificado solo tras verificar sus nombres y cadena.POST /api/application/updateSSLCertificate

Cambiar HTTP o certificados puede interrumpir clientes activos. Valida DNS, cadena, puertos y acceso de reversión.

POST
/api/application/getAppInfo
Endpoint público

Consulta públicamente los datos de Callaba Engine antes de realizar cambios globales. No requiere token de API.

La respuesta incluye node_app, stack_version_name, stack_version, custom_settings, http_modes, needLicenceKey, las URL de conferencia en global_module_settings y read_preference.

El campo de éxito se llama suceess. El cliente debe leer exactamente ese nombre.

Parámetros del cuerpo de la solicitud
Este método no tiene parámetros
Obtener información de la aplicación
Copiar código
curl --request POST \
--url http://localhost/api/application/getAppInfo \
--header 'Content-Type: application/json' \
--data '{}'
Respuesta
Versiones
node_app / stack_version_name / stack_version
mixed
Copiar enlace directo

Variante actual del despliegue y campos de versión del stack, obtenidos del registro de la aplicación y del entorno.

Entrega
http_modes
array
Copiar enlace directo

Modos actuales de entrega HTTP almacenados en el registro de la aplicación.

Ajustes personalizados
custom_settings
object
Copiar enlace directo

Ajustes de aplicación personalizados persistentes.

Licencia
needLicenceKey
boolean
Copiar enlace directo

Indica si el registro de la aplicación todavía no tiene una clave de licencia.

Videollamadas
global_module_settings.MODULE_CONFERENCES
object
Copiar enlace directo

Valores actuales de wss_server_url y turn_server_url utilizados para la conectividad de las conferencias.

Base de datos
read_preference
string
Copiar enlace directo

Preferencia de lectura de la base de datos ya resuelta; si no está definida, el backend utiliza su constante de lectura primaria.

Resultado de la operación
suceess
boolean
Copiar enlace directo

El backend actual devuelve este campo con el nombre escrito así, suceess, y con el valor true.

Respuesta: Obtener información de la aplicación
JSON
Copiar código
{
"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
Requiere token de API
POST
/api/application/updateSSLCertificate
Requiere token de API
POST
/api/application/updateCustomSettings
Requiere token de API
POST
/api/application/importDb
Requiere token de API
POST
/api/application/exportDb
Requiere token de API
POST
/api/application/updateNTPConfiguration
Requiere token de API