Descripción general de la API de gestión del ciclo de vida de las VM

Guía completa de la API REST para la gestión del ciclo de vida de máquinas virtuales en VergeOS: crear, administrar, configurar y eliminar VMs de forma programática

Puntos clave

• API REST completa para la gestión del ciclo de vida y la automatización de máquinas virtuales

• Crear, configurar, administrar y eliminar VM mediante programación usando endpoints HTTP

• Flujo de trabajo de la API en cuatro etapas: Creación → Gestión de energía → Configuración → Operaciones avanzadas

• Documentación completa de la API optimizada para desarrolladores y herramientas de automatización

Etapa: Resumen de la API (punto de entrada) Entrada: Requisitos del desarrollador, necesidades de automatización Salida: Flujo guiado hacia la documentación específica de la API Ruta de navegación:

• Empiece aquí → Elija una operación específica → Siga las guías detalladas

• Ciclo de vida completo: Creación → Energía → Configuración → Avanzadas

Este documento ayuda con

• "Resumen de la API de VM y primeros pasos"

• "Flujo de trabajo de la API REST para la gestión de VM"

• "Referencia de endpoints de la API y navegación"

• "Integración para desarrolladores con las APIs de VergeOS"

• "Planificación de infraestructura como código"

• "Diseño de flujo de trabajo de automatización"

• "Guía de integración de la API"

• "Estrategia de automatización de la gestión de VM"

Etapas del flujo de trabajo de la API

1. API de creación de VM

Cree máquinas virtuales mediante programación con unidades, dispositivos e interfaces de red usando llamadas a la API REST. → Ver: Creación de VM

2. API de gestión de energía de VM

Inicie, detenga, reinicie y supervise los estados de energía de la VM a través de endpoints de la API. → Ver: Gestión de energía de la VM

3. API de configuración de VM

Modifique CPU, RAM, unidades de almacenamiento y ajustes de red mediante llamadas a la API. → Ver: Configuración de la VM

4. API de operaciones avanzadas de VM

Clone VM, cree instantáneas, elimine máquinas virtuales y resuelva problemas usando métodos de la API. → Ver: Operaciones avanzadas de VM

Conceptos clave de la API

• Clave de VM frente a clave de máquina: Distinción de la API para ajustes de VM frente a operaciones de hardware

• Autenticación de la API REST: Se requiere autenticación con token Bearer para todas las llamadas a la API

• Grupos de recursos: Parámetros de API basados en UUID para la asignación directa de dispositivos (GPU, dispositivos PCI)

• Niveles de almacenamiento: Niveles de rendimiento configurables por API (1-5) para la ubicación de unidades

• Métodos HTTP: Operaciones GET, POST, PUT, DELETE para la gestión completa del ciclo de vida de la VM

Endpoints principales de la API

Operación de la API	Método HTTP	Endpoint REST	Propósito
Crear VM	POST	/api/v4/vms	Crear nueva máquina virtual
Acciones de VM	POST	/api/v4/vm_actions	Operaciones de energía, clonar, instantánea
Actualizar VM	PUT	/api/v4/vms/{id}	Modificar la configuración de la VM
Agregar almacenamiento	POST	/api/v4/machine_drives	Adjuntar unidades a la VM
Agregar red	POST	/api/v4/machine_nics	Configurar interfaces de red
Agregar dispositivos	POST	/api/v4/machine_devices	Adjuntar dispositivos GPU/PCI
Eliminar VM	DELETE	/api/v4/vms/{id}	Eliminar la máquina virtual
Estado de la VM	GET	/api/v4/vms/{id}	Consultar información de la VM
Estado de energía	GET	/api/v4/machine_status/{id}	Comprobar el estado de ejecución

Referencia rápida de la API por etapa

Etapa	Operaciones principales	Endpoints clave	Documentación
Creación	Crear VM, agregar unidades, agregar NIC, agregar dispositivos	POST /api/v4/vms, POST /api/v4/machine_*	Creación de VM
Energía	Iniciar, detener, reiniciar, supervisar	POST /api/v4/vm_actions, GET /api/v4/machine_status	Gestión de energía de la VM
Config.	Actualizar CPU/RAM, administrar unidades, administrar NIC	PUT /api/v4/vms, POST/PUT/DELETE /api/v4/machine_*	Configuración de la VM
Avanzado	Clonar, instantánea, eliminar, solucionar problemas	POST /api/v4/vm_actions, DELETE /api/v4/vms	Operaciones avanzadas de VM

Escenarios comunes de error de la API

• Problemas de autenticación: Clave de API no válida, tokens expirados, permisos insuficientes

• Restricciones de recursos: Almacenamiento insuficiente, límites de memoria, cuotas de CPU excedidas

• Errores de configuración: Parámetros no válidos, campos obligatorios faltantes, JSON mal formado

• Conflictos de estado: La VM ya está en ejecución, operación en curso, recurso bloqueado

• Problemas de red: Tiempo de espera de la API, conexión rechazada, servicio no disponible

• Errores de validación: Nombres de VM no válidos, configuraciones no admitidas, violaciones de restricciones

Guía de introducción a la API

1. Crear VM - Llamadas a la API REST para crear máquinas virtuales

2. Control de energía - Endpoints de la API para iniciar, detener y administrar VM

3. Configurar VM - Métodos de la API para modificar ajustes y hardware de la VM

4. Operaciones avanzadas - Llamadas a la API para clonado, copia de seguridad y resolución de problemas

Casos de uso comunes de la API

• Aprovisionamiento automatizado de VM: Cree VM mediante programación para la automatización en la nube

• Infraestructura como código: Administre la infraestructura de máquinas virtuales mediante llamadas a la API

• Integración DevOps: Integre la gestión de VM en canalizaciones CI/CD usando API REST

• Monitoreo y alertas: Consulte el estado de la VM y los estados de energía mediante endpoints de la API

• Copia de seguridad y recuperación: Automatice instantáneas y clonación de VM a través de operaciones de la API

• Gestión de recursos: Administre mediante programación la asignación de CPU, memoria y almacenamiento de la VM

Autenticación de la API

Todos los endpoints de la API del ciclo de vida de la VM requieren autenticación:

curl -H "Authorization: Bearer YOUR_API_KEY" \\
     -H "Content-Type: application/json" \\
     https://your-vergeos.example.com/api/v4/vms

Comience con la documentación de la API de creación de VM para empezar a automatizar sus flujos de trabajo de gestión de máquinas virtuales.