REST Resource: projects.locations.deliveryPipelines.automationRuns

Ressource: AutomationRun

Eine AutomationRun-Ressource in der Cloud Deploy API.

Ein AutomationRun steht für eine Ausführungsinstanz einer Automatisierungsregel.

JSON-Darstellung 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "serviceAccount": string,
  "automationSnapshot": {
    object (Automation)
  },
  "targetId": string,
  "state": enum (State),
  "stateDescription": string,
  "expireTime": string,
  "ruleId": string,
  "automationId": string,
  "waitUntilTime": string,

  // Union field operation can be only one of the following:
  "promoteReleaseOperation": {
    object (PromoteReleaseOperation)
  },
  "advanceRolloutOperation": {
    object (AdvanceRolloutOperation)
  },
  "repairRolloutOperation": {
    object (RepairRolloutOperation)
  }
  // End of list of possible types for union field operation.
}
Felder
name

string

Nur Ausgabe. Name von AutomationRun. Das Format ist projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/automationRuns/{automationRun}.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem das AutomationRun erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem der AutomatisierungsRun aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
etag

string

Nur Ausgabe. Das schwache ETag der Ressource AutomationRun. Diese Prüfsumme wird vom Server basierend auf dem Wert anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren über einen aktuellen Wert verfügt.
serviceAccount

string

Nur Ausgabe. E-Mail-Adresse des nutzerverwalteten IAM-Dienstkontos, das die Vorgänge für Cloud Deploy-Ressourcen ausführt.
automationSnapshot

object (Automation)

Nur Ausgabe. Snapshot der Automatisierung, die zum Zeitpunkt der AutomationRun-Erstellung aufgenommen wurde.
targetId

string

Nur Ausgabe. Die ID des Ziels, das die Hochstufungsphase darstellt, die AutomationRun initiiert. Der Wert in diesem Feld ist das letzte Segment eines Zielnamens.
state

enum (State)

Nur Ausgabe. Aktueller Status von AutomationRun.
stateDescription

string

Nur Ausgabe. Erklärt den aktuellen Status von AutomationRun. Präsentieren Sie Ihre Präsentation nur, wenn eine Erklärung erforderlich ist.
expireTime

string (Timestamp format)

Nur Ausgabe. Zeit, zu der die AutomationRun abläuft. AutomationRun läuft 14 Tage nach dem Erstellungsdatum ab.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
ruleId

string

Nur Ausgabe. Die ID der Automatisierungsregel, die den Vorgang initiiert hat.
automationId

string

Nur Ausgabe. Die ID der Automatisierung, die den Vorgang initiiert hat.
waitUntilTime

string (Timestamp format)

Nur Ausgabe. Frühester Versuch, das Gerät (AutomationRun) fortzusetzen. Die Wartezeit wird von wait in der Automatisierungsregel konfiguriert.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
Union-Feld operation. Der Vorgang, der vom AutomationRun ausgeführt wird. Für operation ist nur einer der folgenden Werte zulässig:
promoteReleaseOperation

object (PromoteReleaseOperation)

Nur Ausgabe. Hochgestuft einen Release zu einem angegebenen Ziel.
advanceRolloutOperation

object (AdvanceRolloutOperation)

Nur Ausgabe. Bringt ein Roll-out in die nächste Phase über.
repairRolloutOperation

object (RepairRolloutOperation)

Nur Ausgabe. Repariert ein fehlgeschlagenes Rollout.

Status

Gültiger Status eines AutomationRun.

Enums
STATE_UNSPECIFIED Der Status der AutomationRun ist nicht spezifiziert.
SUCCEEDED AutomationRun ist erfolgreich.
CANCELLED AutomationRun wurde abgebrochen.
FAILED Fehler beim AutomationRun.
IN_PROGRESS AutomationRun wird ausgeführt.
PENDING AutomationRun steht aus.
ABORTED AutomationRun wurde abgebrochen.

PromoteReleaseOperation

Enthält die Informationen zu einem automatisierten Hochstufungs-/Release-Vorgang.

JSON-Darstellung 
{
  "targetId": string,
  "wait": string,
  "rollout": string,
  "phase": string
}
Felder
targetId

string

Nur Ausgabe. Die ID des Ziels, das die Hochstufungsphase darstellt, zu der der Release hochgestuft wird. Der Wert in diesem Feld ist das letzte Segment eines Zielnamens.
wait

string (Duration format)

Nur Ausgabe. Wie lange der Vorgang pausiert wird.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
rollout

string

Nur Ausgabe. Der Name des Roll-outs, das AutomationRun initiiert.
phase

string

Nur Ausgabe. Die Startphase des Roll-outs, das durch diesen Vorgang erstellt wird.

AdvanceRolloutOperation

Enthält die Informationen zu einem automatisierten Vorgang für das Fortsetzen des Rollouts.

JSON-Darstellung 
{
  "sourcePhase": string,
  "wait": string,
  "rollout": string,
  "destinationPhase": string
}
Felder
sourcePhase

string

Nur Ausgabe. Die Phase einer Bereitstellung, die den Vorgang initiiert hat.
wait

string (Duration format)

Nur Ausgabe. Wie lange der Vorgang pausiert wird.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
rollout

string

Nur Ausgabe. Der Name des Roll-outs, das AutomationRun initiiert.
destinationPhase

string

Nur Ausgabe. Die Phase, in der das Roll-out fortgesetzt wird.

RepairRolloutOperation

Enthält die Informationen für einen automatisierten repair rollout-Vorgang.

JSON-Darstellung 
{
  "rollout": string,
  "currentRepairModeIndex": string,
  "repairPhases": [
    {
      object (RepairPhase)
    }
  ],
  "phaseId": string,
  "jobId": string
}
Felder
rollout

string

Nur Ausgabe. Der Name des Roll-outs, das AutomationRun initiiert.
currentRepairModeIndex

string (int64 format)

Nur Ausgabe. Der Index der aktuellen Reparaturaktion in der Reparatursequenz.
repairPhases[]

object (RepairPhase)

Nur Ausgabe. Aufzeichnungen der Reparaturversuche. Für jede Reparaturphase können mehrere Wiederholungsversuche oder ein Rollback versucht werden.
phaseId

string

Nur Ausgabe. Die Phasen-ID der Phase, die den zu reparierenden Job enthält.
jobId

string

Nur Ausgabe. Die Job-ID für den zu reparierenden Job.

RepairPhase

„RepairPhase“ erfasst die Reparaturversuche für jeden RepairMode, der in der Ressource „Automation“ angegeben ist.

JSON-Darstellung 
{

  // Union field repair_phase can be only one of the following:
  "retry": {
    object (RetryPhase)
  },
  "rollback": {
    object (RollbackAttempt)
  }
  // End of list of possible types for union field repair_phase.
}
Felder

Union-Feld repair_phase.

Für repair_phase ist nur einer der folgenden Werte zulässig:
retry

object (RetryPhase)

Nur Ausgabe. Einträge der Wiederholungsversuche für den Wiederholungsmodus.
rollback

object (RollbackAttempt)

Nur Ausgabe. Rollback-Versuch für Rollback-Reparaturmodus .

RetryPhase

RepeatPhase enthält die Wiederholungsversuche und die Metadaten zum Initiieren eines neuen Versuchs.

JSON-Darstellung 
{
  "totalAttempts": string,
  "backoffMode": enum (BackoffMode),
  "phaseId": string,
  "jobId": string,
  "attempts": [
    {
      object (RetryAttempt)
    }
  ]
}
Felder
totalAttempts

string (int64 format)

Nur Ausgabe. Die Anzahl der erfolgten Versuche.
backoffMode

enum (BackoffMode)

Nur Ausgabe. Das Muster, mit dem die Wartezeit für Wiederholungsversuche berechnet wird.
phaseId
(deprecated)

string

Nur Ausgabe. Die Phasen-ID der Phase, zu der der Wiederholungsversuch gehört.
jobId
(deprecated)

string

Nur Ausgabe. Die Job-ID für den zu wiederholenden Job.
attempts[]

object (RetryAttempt)

Nur Ausgabe. Detail einer Wiederholungsaktion.

RetryAttempt

„RepeatAttempt“ stellt eine Aktion dar, bei der der fehlgeschlagene Cloud Deploy-Job wiederholt wird.

JSON-Darstellung 
{
  "attempt": string,
  "wait": string,
  "state": enum (RepairState),
  "stateDesc": string
}
Felder
attempt

string (int64 format)

Nur Ausgabe. Der Index dieses Wiederholungsversuchs.
wait

string (Duration format)

Nur Ausgabe. Wie lange der Vorgang pausiert wird.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
state

enum (RepairState)

Nur Ausgabe. Gültiger Status dieser Wiederholungsaktion.
stateDesc

string

Nur Ausgabe. Beschreibung des Status des Wiederholungsstatus.

RepairState

Gültiger Status eines Reparaturversuchs.

Enums
REPAIR_STATE_UNSPECIFIED Der Status der repair ist nicht spezifiziert.
REPAIR_STATE_SUCCEEDED Die Aktion repair war erfolgreich.
REPAIR_STATE_CANCELLED Die Aktion repair wurde abgebrochen.
REPAIR_STATE_FAILED Bei der Aktion repair ist ein Fehler aufgetreten.
REPAIR_STATE_IN_PROGRESS Die Aktion repair wird ausgeführt.
REPAIR_STATE_PENDING Die Aktion repair steht aus.
REPAIR_STATE_SKIPPED Die Aktion „repair“ wurde übersprungen.
REPAIR_STATE_ABORTED Die Aktion repair wurde abgebrochen.

RollbackAttempt

RollbackAttempt steht für eine Aktion beim Rollback eines Cloud Deploy-Ziels.

JSON-Darstellung 
{
  "destinationPhase": string,
  "rolloutId": string,
  "state": enum (RepairState),
  "stateDesc": string
}
Felder
destinationPhase

string

Nur Ausgabe. Die Phase, auf die das Roll-out zurückgesetzt wird.
rolloutId

string

Nur Ausgabe. ID des zu erstellenden Rollback-Rollout.
state

enum (RepairState)

Nur Ausgabe. Gültiger Status dieser Rollback-Aktion.
stateDesc

string

Nur Ausgabe. Beschreibung des Rollback-Status.

Methoden

cancel

 Bricht einen AutomationRun ab.

get

 Ruft Details zu einem einzelnen AutomationRun ab.

list

 Listet AutomationRuns in einem bestimmten Projekt und an einem bestimmten Standort auf.