Skip to main content

eEVOS HCI REST API – Einstieg und Referenz

Die REST API von eEVOS HCI ermöglicht die Automatisierung der produktspezifischen Administration. Diese Dokumentation gehört ausschließlich zu diesem Produkt; eEKAS, HA Cluster und eEVOS HCI besitzen unterschiedliche API-Umfänge.

Aktuelle Referenz und Downloads

Stand: 23. Oktober 2026. Version 1.0.0. 347 Operationen.

Funktionsumfang

Virtuelle Maschinen (146 Operationen), Ceph (60), Cluster (54), Netzwerke, Hardware-Sensoren, Benutzer sowie iSCSI- und NVMe-Initiatoren.

Die eEVOS-HCI-Referenz ist die API-Dokumentation für euronas-hci. Verwenden Sie für VM- und HCI-Automatisierung diese Referenz und nicht die eEKAS-S3-/Hosting-Referenz.

Zugang und Authentifizierung

  1. REST API in der Administration des installierten Systems aktivieren und ein geeignetes Management-Interface sowie API-Zugang konfigurieren. Neue externe Konfigurationen verwenden standardmäßig 127.0.0.1; für Fernzugriff muss ein erreichbares Interface gewählt werden.
  2. Basisadresse: https://<server>:18443. Port und Adresse an die tatsächliche Konfiguration anpassen.
  3. Bei jedem geschützten Aufruf den Header X-API-Key: <API_KEY> mitsenden. HTTPS-Zertifikate prüfen; bei privater CA --cacert /path/to/ca.pem.
  4. Passwörter, Tokens, API-Schlüssel und Fencing-Zugangsdaten ausschließlich im JSON-Request-Body übertragen, nie in URLs. Content-Type: application/json.

Erste Lesezugriffe

Platzhalter ersetzen. Zuerst die Produktfähigkeiten und anschließend den Status abfragen:

curl --fail-with-body -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/product/capabilities'

curl --fail-with-body -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/status'

curl --fail-with-body -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms'

Zuverlässige Automatisierung

  • Für wiederholbare POST-, PUT-, PATCH- und DELETE-Aufrufe einen eindeutigen Idempotency-Key. Bei Wiederholung desselben Auftrags denselben Schlüssel verwenden. Cluster-Bootstrap und -Beitritt verlangen diesen Header.
  • Eine Antwort mit HTTP 202 bestätigt nur die Annahme. Die zurückgegebene status_url bis zum Abschluss abfragen; nicht allein aus HTTP 202 auf Erfolg schließen.
  • X-Correlation-ID aus Antworten für Nachverfolgung aufbewahren. API-Schlüssel und andere Geheimnisse nicht protokollieren.

Fehlerbehandlung

HTTP Bedeutung / Vorgehen
400 / 422 Eingaben und Parameter prüfen; Geheimnisse in URLs werden abgewiesen.
401 / 403 API-Schlüssel bzw. Berechtigungen prüfen.
409 Konflikt mit dem aktuellen Zustand; Zustand prüfen, nicht blind wiederholen.
428 Erforderlicher Idempotency-Key fehlt.
429 / 503 Rate- oder Kapazitätsgrenze. Verzögert wiederholen und Retry-After beachten, sofern vorhanden.
501 Operation wird von diesem Produkt nicht unterstützt.

Zur installierten Version passende Dokumentation

Verfügbarkeit hängt von installierter Version und aktivierten Funktionen ab. Bei aktivierter Dokumentation können berechtigte API-Clients /api/docs, /api/openapi.json und /api/openapi.yaml am konfigurierten API-Endpunkt abrufen. Diese Ressourcen benötigen einen gültigen API-Schlüssel. Maßgeblich sind die vom installierten System unterstützten Operationen.

Nutzung und Support

Die Nutzung der API erfolgt in eigener Verantwortung und ist nicht durch den Support abgedeckt. Automatisierung zunächst mit geeigneten Testressourcen prüfen und die Voraussetzungen der jeweiligen Operation beachten.

Back to top