Updates

Update-Angebote vom Hub und die Anforderung, eines davon zu installieren.

Die Vorgänge dieser Gruppe mit ihrer Zugriffsregel, Wiederholungsregel, ihren Parametern und Antworten. Jede Anfrage trägt einen Schlüssel: Authorization: Bearer <Schlüssel> (siehe „Authentifizierung“).

Vorgänge

Update-Zustand abrufen

GET HEAD /api/v1/system/updates

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert, was der Host-Updater meldet: die installierte Version und das Schema, das neueste gefundene Release (latest), die Einstellungen für automatische Updates (automatic, hourUTC, pin, channel, statistics), die phase (idle, checking, updating, failed), den letzten error, den letzten Heartbeat und die revision der Einstellungen, dazu die Anfrage, die noch im Postfach des Updaters wartet (pending). snapshot ist null, wenn kein Host-Updater verbunden ist. Übergeben Sie revision an requestSystemUpdate.

Antwort 200

Feld	Typ	Erforderlich	Regeln
snapshot	object	ja	darf null sein
snapshot.revision	integer	ja	0–2147483646
snapshot.currentVersion	string	ja	entspricht ^(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})$
snapshot.currentSchema	integer	ja	0–2147483647
snapshot.automatic	boolean	ja	—
snapshot.hourUTC	integer	ja	0–23
snapshot.pin	string	ja	entspricht ^(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})$; darf null sein
snapshot.heartbeatAt	string (date-time)	ja	—
snapshot.checkedAt	string (date-time)	ja	darf null sein
snapshot.latest	object	ja	darf null sein
snapshot.latest.version	string	ja	entspricht ^(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})$
snapshot.latest.schema	integer	ja	0–2147483647
snapshot.latest.sha256	string	ja	SHA-256: 64 hexadezimale Ziffern in Kleinbuchstaben
snapshot.phase	string	ja	einer von idle, checking, updating, failed
snapshot.error	string	ja	einer von check_failed, update_failed, conflict, maintenance_required, recovery_required, null; darf null sein
snapshot.lastAttemptDay	string	ja	darf null sein
snapshot.lastRequestId	string (uuid)	ja	darf null sein
snapshot.statistics	boolean	nein	—
snapshot.channel	string	nein	einer von stable, beta
pending	object	ja	einer von null
pending.id	string (uuid)	ja	—
pending.expectedRevision	integer	ja	0–2147483646
pending.kind	string	ja	einer von check
pending.version	string	ja	entspricht ^(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})$
pending.sha256	string	ja	SHA-256: 64 hexadezimale Ziffern in Kleinbuchstaben
pending.automatic	boolean	ja	—
pending.hourUTC	integer	ja	0–23
pending.statistics	boolean	nein	—

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

curl -X GET "$ARKVORY_URL/api/v1/system/updates" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Eine Update-Aktion anfordern

POST /api/v1/system/updates/requests

Zugriff: Administrator · Wiederholung: Nur mit der erwarteten Revision wiederholen (compare-and-swap)

Übergibt dem Host-Updater, der die Arbeit erledigt, einen Befehl: kind check sucht nach einem neuen Release, apply installiert die angegebene stabile version mit ihrem sha256, configure setzt automatic, hourUTC und optional statistics. Senden Sie eine neue UUID als id und die expectedRevision aus getSystemUpdates; 409 revision_mismatch bedeutet, dass sich die Einstellungen geändert haben, 503 busy, dass eine Anfrage aussteht oder der Updater arbeitet, 503 unavailable, dass kein Updater verbunden ist oder sein Heartbeat älter als fünf Minuten ist. Die Antwort 202 bedeutet nur, dass die Anfrage eingereiht wurde: Verfolgen Sie phase, currentVersion und lastRequestId in getSystemUpdates. Dieselbe id mit demselben Body zu wiederholen ist sicher.

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
id	string (uuid)	ja	—
expectedRevision	integer	ja	0–2147483646
kind	string	ja	einer von check
version	string	ja	entspricht ^(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})\.(0|[1-9][0-9]{0,5})$
sha256	string	ja	SHA-256: 64 hexadezimale Ziffern in Kleinbuchstaben
automatic	boolean	ja	—
hourUTC	integer	ja	0–23
statistics	boolean	nein	—

Antwort 202

Feld	Typ	Erforderlich	Regeln
id	string (uuid)	ja	—

Antworten: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

curl -X POST "$ARKVORY_URL/api/v1/system/updates/requests" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-4000-8000-000000000000","expectedRevision":0,"kind":"check"}'