Spiegel

Der Zustand eines gespiegelten Repositorys und der Feed, dem ein Spiegel folgt.

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

Spiegel und Importe dieser Installation auflisten

GET HEAD /api/v1/mirrors

Zugriff: Repositorys, die der Aufrufer sehen darf (repository.read) · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert für jedes Repository, das dieser Server aus einem anderen Arkvory spiegelt oder importiert und das der Aufrufer lesen darf, denselben Zustand wie der Spiegelstatus eines Repositorys: Quelle, mode, phase, cursor und head, caughtUp, letzte Prüfung, Synchronisation und Fehler sowie die kopierten Artefakte und Bytes. Repositorys, die der Aufrufer nicht lesen darf, werden ausgelassen; eine Installation ohne Spiegel antwortet mit einer leeren Liste.

Antwort 200

Feld	Typ	Erforderlich	Regeln
items	Array von object	ja	höchstens 64 Elemente
items[].repository	string	ja	—
items[].upstream	string (uri)	ja	—
items[].sourceRepository	string	ja	—
items[].mode	string	ja	einer von mirror, import
items[].stages	Array von string	ja	höchstens 16 Elemente
items[].phase	string	ja	einer von pending, seeding, following
items[].seedStep	string	ja	einer von artifacts, packages, assets; darf null sein
items[].cursor	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
items[].head	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet; darf null sein
items[].caughtUp	boolean	ja	darf null sein
items[].checkedAt	string (date-time)	ja	darf null sein
items[].syncedAt	string (date-time)	ja	darf null sein
items[].errorCode	string	ja	darf null sein
items[].errorAt	string (date-time)	ja	darf null sein
items[].copiedArtifacts	integer	ja	mindestens 0
items[].copiedBytes	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
items[].conflicts	object	ja	—
items[].conflicts.count	integer	ja	mindestens 0
items[].conflicts.oldestAt	string (date-time)	ja	darf null sein
items[].conflicts.sample	Array von object	ja	höchstens 10 Elemente

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

Beispiel

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

Synchronisierungszustand eines Spiegels abrufen

GET HEAD /api/v1/repositories/{repository}/mirror

Zugriff: Repository-Berechtigung: repository.read; Dateischlüssel: read · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert für ein Repository, das dieser Server von einem anderen Arkvory spiegelt (konfiguriert in ARKVORY_MIRRORS_FILE), die Quelle, den mode (mirror, eine schreibgeschützte Kopie, oder import, der Versionen mit den aufgelisteten stages übernimmt), die phase (pending, seeding, following), den angewendeten cursor und den head der Quelle, caughtUp, die letzte Prüfung, die letzte Synchronisierung und den letzten Fehler sowie die kopierten Artefakte und Bytes. Sequenzen sind Journalnummern der Quelle, ihre Differenz ist daher keine Anzahl von Änderungen. Ein gewöhnliches Repository antwortet mit 404.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
repository	Pfad	string	ja	entspricht ^[a-z0-9][a-z0-9_-]{0,63}$

Antwort 200

Feld	Typ	Erforderlich	Regeln
repository	string	ja	—
upstream	string (uri)	ja	—
sourceRepository	string	ja	—
mode	string	ja	einer von mirror, import
stages	Array von string	ja	höchstens 16 Elemente
phase	string	ja	einer von pending, seeding, following
seedStep	string	ja	einer von artifacts, packages, assets; darf null sein
cursor	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
head	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet; darf null sein
caughtUp	boolean	ja	darf null sein
checkedAt	string (date-time)	ja	darf null sein
syncedAt	string (date-time)	ja	darf null sein
errorCode	string	ja	darf null sein
errorAt	string (date-time)	ja	darf null sein
copiedArtifacts	integer	ja	mindestens 0
copiedBytes	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
conflicts	object	ja	—
conflicts.count	integer	ja	mindestens 0
conflicts.oldestAt	string (date-time)	ja	darf null sein
conflicts.sample	Array von object	ja	höchstens 10 Elemente
conflicts.sample[].artifactId	string (uuid)	ja	—
conflicts.sample[].action	string	ja	—
conflicts.sample[].detail	string	ja	darf null sein
conflicts.sample[].code	string	ja	—
conflicts.sample[].firstAt	string (date-time)	ja	—
conflicts.sample[].lastAt	string (date-time)	ja	—
conflicts.sample[].attempts	integer	ja	mindestens 1

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

Beispiel

curl -X GET "$ARKVORY_URL/api/v1/repositories/$REPOSITORY/mirror" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"