So verwalten Sie Server-Updates über die API

Bevor Sie die API zur Verwaltung Ihrer Server-Updates verwenden, stellen Sie bitte sicher, dass Sie die in den folgenden Voraussetzungen beschriebenen Anforderungen für die Authentifizierung erfüllen:

Voraussetzungen

Sie haben einen Service Account erstellt. (Siehe: Service Account erstellen)
Sie haben diesem Service Account die erforderlichen Projektberechtigungen zugewiesen. (Siehe: Berechtigungen an einen Service Account zuweisen)
Sie haben ein Zugriffstoken für diesen Service Account erstellt. (Siehe: Authentifizierungstoken an einen Service Account zuweisen)

Server Update Management Service aktivieren

Wenn Sie den Server Update Management Service für einen neuen Server mit dem bereits enthaltenen Standard-Update-Zeitplan aktivieren möchten, senden Sie zunächst die folgende Anfrage, einschließlich der portalProjectId und region in der URL, um die entsprechende Update Policy ID abzurufen:

POST https://server-update.api.stackit.cloud/v2/projects/{portalProjectId}/regions/{region}/servers/{serverId}/service

Server Update Management Service mit einem Standard-Update-Zeitplan aktivieren

If you want to activate the Server Update Management Service for a new server with the default update schedule already included, first send the following request, including the portalProjectId and region in the URL to fetch the proper Update Policy ID:

GET https://server-update.api.stackit.cloud/v2/projects/{portalProjectId}/regions/{region}/update-policies

Senden Sie anschließend eine Anfrage zur Aktivierung des Server Update Management Service und geben Sie die portalProjectId, region, serverId und updatePolicyId im Request-Body an:

Anfrage

POST https://server-update.api.stackit.cloud/v2/projects/{portalProjectId}/regions/{region}/servers/{serverId}/service

{
    "updatePolicyId": "2ab33ea4-9b4b-492c-8679-3d664091c195"
}

Dadurch wird ein wöchentlicher Update-Zeitplan auf Ihrem Server aktiviert.

Update-Installation ausführen

Starten Sie einen neuen Update-Job auf Ihrem Server, indem Sie eine POST-Anfrage an den folgenden Endpunkt senden und dabei die portalProjectId, region, serverId und einen Wert für das maintenanceWindow angeben:

Anfrage

POST https://server-update.api.stackit.cloud/v2/projects/{portalprojectId}/regions/{region}/servers/{serverId}/updates

{
  "maintenanceWindow": 2
}

Diese Anfrage löst die Installation von Updates innerhalb des angegebenen Wartungsfensters aus.

Der Wert maintenanceWindow gibt den Zeitrahmen in Stunden an, in dem der Update-Prozess beginnt.

Status und Ergebnisse des Update-Jobs prüfen

Um den Fortschritt und die Ergebnisse des Updates zu überwachen, verwenden Sie die folgende GET-Anfrage unter Angabe der portalProjectId, region, serverId und updateId, die in der Antwort des gestarteten Update-Jobs angezeigt wird:

Anfrage

GET https://server-update.api.stackit.cloud/v2/projects/{portalprojectId}/regions/{region}/servers/{serverId}/updates/{updateId}

Update-Zeitplan erstellen

Wenn Sie Update-Zeitpläne erstellen, müssen Sie Wiederholungsregeln für Kalenderdaten im Feld rrule gemäß der Internet Calendaring and Scheduling Core Object Specification (iCalendarRFC5545) angeben.

Nachfolgend finden Sie ein Beispiel für die Anfrage, die mit den angegebenen Werten für portalProjectId, region, serverId, rrule und maintenanceWindow gesendet werden muss:

Anfrage

POST https://server-update.api.stackit.cloud/v2/projects/{portalprojectId}/regions/{region}/servers/{serverId}/update-schedules

{
  "name": "Default Update Schedule",
 "rrule": "DTSTART;TZID=Europe/Sofia:20200803T134000 RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=SA",
  "enabled": true,
  "maintenanceWindow": 2
}

Die vollständige API-Dokumentation, einschließlich aller verfügbaren Endpunkte und Beispiele, finden Sie hier: STACKIT Server Update Management API.