Überblick über die API für VM-Lifecycle-Management

Vollständige REST-API-Anleitung für das Lifecycle-Management virtueller Maschinen in VergeOS – VMs programmgesteuert erstellen, verwalten, konfigurieren und löschen

Wichtige Punkte

• Vollständige REST-API für die Verwaltung und Automatisierung des Lebenszyklus virtueller Maschinen
• Virtuelle Maschinen programmgesteuert über HTTP-Endpunkte erstellen, konfigurieren, verwalten und löschen
• Vierstufiger API-Workflow: Erstellung → Energiemanagement → Konfiguration → Erweiterte Operationen
• Umfassende API-Dokumentation, optimiert für Entwickler und Automatisierungstools

Stufe: API-Übersicht (Einstiegspunkt) Eingabe: Anforderungen für Entwickler, Automatisierungsbedarf Ausgabe: Geführter Workflow zur spezifischen API-Dokumentation Navigationspfad:

• Hier beginnen → Spezifische Operation auswählen → Detaillierten Anleitungen folgen
• Vollständiger Lebenszyklus: Erstellung → Energie → Konfiguration → Erweitert

Dieses Dokument hilft bei

• "VM-API-Übersicht und Einstieg"
• "REST-API-Workflow für die VM-Verwaltung"
• "API-Endpunktreferenz und Navigation"
• "Onboarding für Entwickler für VergeOS-APIs"
• "Planung für Infrastructure as Code"
• "Entwurf des Automatisierungs-Workflows"
• "Leitfaden zur API-Integration"
• "Automatisierungsstrategie für die VM-Verwaltung"

API-Workflow-Phasen

1. VM-Erstellungs-API

Erstellen Sie virtuelle Maschinen programmgesteuert mit Laufwerken, Geräten und Netzwerkschnittstellen über REST-API-Aufrufe. → Siehe: VM-Erstellung

2. VM-Energiemanagement-API

Starten, stoppen, neu starten und überwachen Sie den Energiezustand von VMs über API-Endpunkte. → Siehe: VM-Energieverwaltung

3. VM-Konfigurations-API

Ändern Sie CPU, RAM, Speicherlaufwerke und Netzwerkeinstellungen per API-Aufruf. → Siehe: VM-Konfiguration

4. API für erweiterte VM-Operationen

Klonen Sie VMs, erstellen Sie Snapshots, löschen Sie virtuelle Maschinen und beheben Sie Probleme mithilfe von API-Methoden. → Siehe: Erweiterte VM-Vorgänge

Wichtige API-Konzepte

• VM-Schlüssel vs. Maschinen-Schlüssel: API-Unterscheidung zwischen VM-Einstellungen und Hardware-Operationen
• REST-API-Authentifizierung: Für alle API-Aufrufe ist eine Bearer-Token-Authentifizierung erforderlich
• Ressourcengruppen: UUID-basierte API-Parameter für Device-Passthrough (GPUs, PCI-Geräte)
• Speicherstufen: Per API konfigurierbare Leistungsstufen (1-5) für die Laufwerksplatzierung
• HTTP-Methoden: GET-, POST-, PUT- und DELETE-Operationen für die vollständige VM-Lebenszyklusverwaltung

Wichtige API-Endpunkte

API-Operation	HTTP-Methode	REST-Endpunkt	Zweck
VM erstellen	POST	/api/v4/vms	Neue virtuelle Maschine erstellen
VM-Aktionen	POST	/api/v4/vm_actions	Energieoperationen, Klonen, Snapshot
VM aktualisieren	PUT	/api/v4/vms/{id}	VM-Konfiguration ändern
Speicher hinzufügen	POST	/api/v4/machine_drives	Laufwerke an VM anhängen
Netzwerk hinzufügen	POST	/api/v4/machine_nics	Netzwerkschnittstellen konfigurieren
Geräte hinzufügen	POST	/api/v4/machine_devices	GPU-/PCI-Geräte anhängen
VM löschen	DELETE	/api/v4/vms/{id}	Virtuelle Maschine entfernen
VM-Status	GET	/api/v4/vms/{id}	VM-Informationen abfragen
Energiezustand	GET	/api/v4/machine_status/{id}	Laufzeitstatus prüfen

API-Schnellreferenz nach Phase

Stufe	Hauptoperationen	Wichtige Endpunkte	Dokumentation
Erstellung	VM erstellen, Laufwerke hinzufügen, NICs hinzufügen, Geräte hinzufügen	POST /api/v4/vms, POST /api/v4/machine_*	VM-Erstellung
Energie	Starten, Stoppen, Neustarten, Überwachen	POST /api/v4/vm_actions, GET /api/v4/machine_status	VM-Energieverwaltung
Konfiguration	CPU/RAM aktualisieren, Laufwerke verwalten, NICs verwalten	PUT /api/v4/vms, POST/PUT/DELETE /api/v4/machine_*	VM-Konfiguration
Erweitert	Klonen, Snapshot, Löschen, Fehlerbehebung	POST /api/v4/vm_actions, DELETE /api/v4/vms	Erweiterte VM-Vorgänge

Häufige API-Fehlerszenarien

• Authentifizierungsprobleme: Ungültiger API-Schlüssel, abgelaufene Token, unzureichende Berechtigungen
• Ressourcenbeschränkungen: Unzureichender Speicherplatz, Speichergrenzen, CPU-Quoten überschritten
• Konfigurationsfehler: Ungültige Parameter, fehlende Pflichtfelder, fehlerhaftes JSON
• Statuskonflikte: VM läuft bereits, Operation läuft, Ressource gesperrt
• Netzwerkprobleme: API-Timeout, Verbindung verweigert, Dienst nicht verfügbar
• Validierungsfehler: Ungültige VM-Namen, nicht unterstützte Konfigurationen, Einschränkungsverletzungen

API-Einstiegsleitfaden

1. VMs erstellen - REST-API-Aufrufe zum Erstellen virtueller Maschinen
2. Energieverwaltung - API-Endpunkte zum Starten, Stoppen und Verwalten von VMs
3. VMs konfigurieren - API-Methoden zum Ändern von VM-Einstellungen und Hardware
4. Erweiterte Vorgänge - API-Aufrufe für Klonen, Sicherung und Fehlerbehebung

Häufige API-Anwendungsfälle

• Automatisierte VM-Bereitstellung: VMs programmgesteuert für Cloud-Automatisierung erstellen
• Infrastructure as Code: Verwalten Sie die Infrastruktur virtueller Maschinen über API-Aufrufe
• DevOps-Integration: Integrieren Sie die VM-Verwaltung mithilfe von REST-APIs in CI/CD-Pipelines
• Überwachung und Alarmierung: VM-Status und Energiezustände über API-Endpunkte abfragen
• Sicherung und Wiederherstellung: VM-Snapshots und Klonen über API-Operationen automatisieren
• Ressourcenverwaltung: CPU-, Speicher- und Speicherzuweisung von VMs programmgesteuert verwalten

API-Authentifizierung

Für alle API-Endpunkte des VM-Lebenszyklus ist eine Authentifizierung erforderlich:

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

Beginnen Sie mit der Dokumentation der VM-Erstellungs-API, um Ihre Workflows zur Verwaltung virtueller Maschinen zu automatisieren.