API Ambientes

Llamadas de API para la operación de Ambientes.

Base path: /environments/

---

Listar Ambientes

Listado de todos los ambientes.

GET /environments/

Respuesta

Status: 200 OK

[
    {
        "amb_uuid": "dd2f7c4e-8dee-4ecc-8033-f21207945d55",
        "nome": "Ambiente 1",
        "in_maintenance": false,
        "maintenance_msg": "En mantenimiento",
        "schedule_maintenance": false,
        "schedule_maintenance_start": "2020-12-11T03:10:14-03:00",
        "schedule_maintenance_end": "2020-12-12T07:35:15-03:00",
        "schedule_maintenance_msg": "En mantenimiento",
        "terminate_sessions": false,
        "terminate_instances": false,
        "schedule_warning": false,
        "schedule_warning_start": "2020-12-24T00:00:00-03:00",
        "schedule_warning_end": "2020-12-25T00:00:00-03:00",
        "schedule_warning_msg": "¡Feliz Navidad!",
        "display_warning_to_logged_users": false,
        "environment_state": "available",
        "preparation_server": {
            "instance_id": "ocid1.instance.oc1...",
            "name": "TEMPLATE_SERVER_NAME",
            "public_ip": "1.2.3.4",
            "private_ip": "4.3.2.1",
            "instance_state": "RUNNING",
            "stop_time": "2021/03/15 19:42:25"
        }
    }
]

Campos del Objeto Ambiente

Campo	Tipo	Descripción
amb_uuid	string	Identificador único del ambiente
nome	string	Nombre del ambiente
in_maintenance	boolean	Si está en mantenimiento inmediato
maintenance_msg	string	Mensaje de mantenimiento
schedule_maintenance	boolean	Si tiene mantenimiento programado activo
schedule_maintenance_start	string/null	Fecha/hora de inicio del mantenimiento programado
schedule_maintenance_end	string/null	Fecha/hora de fin del mantenimiento programado
schedule_maintenance_msg	string	Mensaje del mantenimiento programado
terminate_sessions	boolean	Si finaliza las sesiones durante el mantenimiento
terminate_instances	boolean	Si finaliza las instancias durante el mantenimiento
schedule_warning	boolean	Si tiene aviso programado activo
schedule_warning_start	string/null	Fecha/hora de inicio del aviso
schedule_warning_end	string/null	Fecha/hora de fin del aviso
schedule_warning_msg	string	Mensaje del aviso
display_warning_to_logged_users	boolean	Si muestra el aviso a los usuarios ya conectados
environment_state	string	Estado del ambiente (ej: available)
preparation_server	object/null	Datos del servidor de preparación (puede ser null)

---

Obtener datos de un ambiente

Obtiene los datos de un ambiente especificado por su UUID.

GET /environments/{amb_uuid}

Parámetros de Path

Parámetro	Obligatorio	Descripción
amb_uuid	Sí	UUID del ambiente

Respuesta

Status: 200 OK

Devuelve el objeto del ambiente con la misma estructura que el listado.

---

Activar / Desactivar mantenimiento inmediato

Activa o desactiva el mantenimiento inmediato en un ambiente completo.

PATCH /environments/{amb_uuid}

Parámetros de Path

Parámetro	Obligatorio	Descripción
amb_uuid	Sí	UUID del ambiente

Cuerpo de la Solicitud

Campo	Tipo	Obligatorio	Descripción
in_maintenance	boolean	Sí	true para activar, false para desactivar
maintenance_msg	string	No	Mensaje presentado a los usuarios durante el próximo inicio de sesión

Respuesta

Status: 200 OK

Devuelve el objeto del ambiente actualizado.

---

Activar / Desactivar mantenimiento programado

Activa o desactiva el mantenimiento programado en un ambiente completo.

Es obligatorio especificar todos los campos a continuación cuando schedule_maintenance sea true.

PATCH /environments/{amb_uuid}

Parámetros de Path

Parámetro	Obligatorio	Descripción
amb_uuid	Sí	UUID del ambiente

Cuerpo de la Solicitud

Campo	Tipo	Obligatorio	Descripción
schedule_maintenance	boolean	Sí	Activa/desactiva el mantenimiento programado
schedule_maintenance_start	string	Condicional	Fecha/hora de inicio. Formato: 2021-12-01T23:10:00.000-03:00
schedule_maintenance_end	string	Condicional	Fecha/hora de finalización
schedule_maintenance_msg	string	Condicional	Mensaje presentado a los usuarios
terminate_sessions	boolean	No	Finaliza las sesiones de los usuarios activos
terminate_instances	boolean	No	Finaliza las instancias activas

Respuesta

Status: 200 OK

Devuelve el objeto del ambiente actualizado.

---

Activar / Desactivar avisos programados

Activa o desactiva la visualización programada de avisos en un ambiente completo.

Es obligatorio especificar todos los campos a continuación cuando schedule_warning sea true.

PATCH /environments/{amb_uuid}

Parámetros de Path

Parámetro	Obligatorio	Descripción
amb_uuid	Sí	UUID del ambiente

Cuerpo de la Solicitud

Campo	Tipo	Obligatorio	Descripción
schedule_warning	boolean	Sí	Activa/desactiva los avisos programados
schedule_warning_start	string	Condicional	Fecha/hora de inicio
schedule_warning_end	string	Condicional	Fecha/hora de finalización
schedule_warning_msg	string	Condicional	Mensaje del aviso
display_warning_to_logged_users	boolean	Condicional	Muestra el aviso a los usuarios ya conectados

Respuesta

Status: 200 OK

Devuelve el objeto del ambiente actualizado.