Aperçu de l’API de gestion du cycle de vie des VM

Guide REST complet pour la gestion du cycle de vie des machines virtuelles dans VergeOS - créer, gérer, configurer et supprimer des VM par programmation

Points clés

• API REST complète pour la gestion du cycle de vie des machines virtuelles et l’automatisation
• Créer, configurer, gérer et supprimer des VM de manière programmatique à l’aide de points de terminaison HTTP
• Flux de travail d’API en quatre étapes : Création → Gestion de l’alimentation → Configuration → Opérations avancées
• Documentation API complète optimisée pour les développeurs et les outils d’automatisation

Étape: Vue d’ensemble de l’API (point d’entrée) Entrée: exigences des développeurs, besoins en automatisation Sortie: parcours guidé vers la documentation API spécifique Chemin de navigation:

• Commencez ici → Choisissez une opération spécifique → Suivez les guides détaillés
• Cycle de vie complet : Création → Alimentation → Configuration → Avancé

Ce document aide pour

• "Présentation de l’API VM et démarrage"
• "Flux de travail de l’API REST pour la gestion des VM"
• "Référence des points de terminaison de l’API et navigation"
• "Intégration des développeurs pour les API VergeOS"
• "Planification de l’infrastructure en tant que code"
• "Conception du flux de travail d’automatisation"
• "Guide d’intégration de l’API"
• "Stratégie d’automatisation de la gestion des VM"

Étapes du flux de travail de l’API

1. API de création de VM

Créez des machines virtuelles de manière programmatique avec des disques, des périphériques et des interfaces réseau à l’aide d’appels à l’API REST. → Voir : Création de VM

2. API de gestion de l’alimentation de la VM

Démarrez, arrêtez, redémarrez et surveillez les états d’alimentation des VM via les points de terminaison de l’API. → Voir : Gestion de l'alimentation de la VM

3. API de configuration de la VM

Modifiez le CPU, la RAM, les disques de stockage et les paramètres réseau via des appels à l’API. → Voir : Configuration de la VM

4. API d’opérations avancées sur la VM

Clonez des VM, créez des instantanés, supprimez des machines virtuelles et résolvez les problèmes à l’aide de méthodes de l’API. → Voir : Opérations avancées de la VM

Concepts clés de l’API

• Clé VM vs clé machine: distinction de l’API entre les paramètres de VM et les opérations matérielles
• Authentification de l’API REST: authentification par jeton Bearer requise pour tous les appels à l’API
• Groupes de ressources: paramètres d’API basés sur UUID pour le passage direct de périphériques (GPU, périphériques PCI)
• Niveaux de stockage: niveaux de performance configurables via l’API (1-5) pour le placement des disques
• Méthodes HTTP: opérations GET, POST, PUT, DELETE pour une gestion complète du cycle de vie des VM

Principaux points de terminaison de l’API

Opération de l’API	Méthode HTTP	Point de terminaison REST	Objectif
Créer la VM	POST	/api/v4/vms	Créer une nouvelle machine virtuelle
Actions VM	POST	/api/v4/vm_actions	Opérations d’alimentation, clonage, instantané
Mettre à jour la VM	PUT	/api/v4/vms/{id}	Modifier la configuration de la VM
Ajouter du stockage	POST	/api/v4/machine_drives	Attacher des disques à la VM
Ajouter le réseau	POST	/api/v4/machine_nics	Configurer les interfaces réseau
Ajouter des périphériques	POST	/api/v4/machine_devices	Attacher des périphériques GPU/PCI
Supprimer la VM	DELETE	/api/v4/vms/{id}	Supprimer la machine virtuelle
État de la VM	GET	/api/v4/vms/{id}	Interroger les informations de la VM
État d’alimentation	GET	/api/v4/machine_status/{id}	Vérifier l’état d’exécution

Référence rapide de l’API par étape

Étape	Opérations principales	Points de terminaison clés	Documentation
Création	Créer une VM, ajouter des disques, ajouter des cartes réseau, ajouter des périphériques	POST /api/v4/vms, POST /api/v4/machine_*	Création de VM
Alimentation	Démarrer, arrêter, redémarrer, surveiller	POST /api/v4/vm_actions, GET /api/v4/machine_status	Gestion de l'alimentation de la VM
Config	Mettre à jour le CPU/RAM, gérer les disques, gérer les cartes réseau	PUT /api/v4/vms, POST/PUT/DELETE /api/v4/machine_*	Configuration de la VM
Avancé	Cloner, instantané, supprimer, dépanner	POST /api/v4/vm_actions, DELETE /api/v4/vms	Opérations avancées de la VM

Scénarios d’erreur courants de l’API

• Problèmes d’authentification: clé API invalide, jetons expirés, permissions insuffisantes
• Contraintes de ressources: stockage insuffisant, limites de mémoire, quotas CPU dépassés
• Erreurs de configuration: paramètres invalides, champs obligatoires manquants, JSON mal formé
• Conflits d’état: VM déjà en cours d’exécution, opération en cours, ressource verrouillée
• Problèmes réseau: délai d’attente de l’API, connexion refusée, service indisponible
• Erreurs de validation: noms de VM invalides, configurations non prises en charge, violations de contraintes

Guide de démarrage de l’API

1. Créer des VM - Appels à l’API REST pour créer des machines virtuelles
2. Contrôle de l’alimentation - Points de terminaison de l’API pour démarrer, arrêter et gérer les VM
3. Configurer les VM - Méthodes de l’API pour modifier les paramètres et le matériel des VM
4. Opérations avancées - Appels à l’API pour le clonage, la sauvegarde et le dépannage

Cas d’utilisation courants de l’API

• Provisionnement automatisé de VM: Créez des VM de manière programmatique pour l’automatisation cloud
• Infrastructure as Code: Gérez l’infrastructure des machines virtuelles via des appels à l’API
• Intégration DevOps: Intégrez la gestion des VM dans les pipelines CI/CD à l’aide d’API REST
• Surveillance et alertes: Interrogez l’état des VM et leurs états d’alimentation via les points de terminaison de l’API
• Sauvegarde et récupération: Automatisez les instantanés et le clonage des VM via les opérations de l’API
• Gestion des ressources: Gérez de manière programmatique l’allocation du CPU, de la mémoire et du stockage des VM

Authentification de l’API

Tous les points de terminaison de l’API du cycle de vie des VM nécessitent une authentification :

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

Commencez par la documentation de l’API de création de VM pour commencer à automatiser vos flux de travail de gestion des machines virtuelles.