REST Resource: projects.locations.deliveryPipelines.releases.rollouts.jobRuns

Ressource: JobRun

Eine JobRun-Ressource in der Cloud Deploy API.

Ein JobRun enthält Informationen zu einer einzelnen Rollout-Jobbewertung.

JSON-Darstellung 
{
  "name": string,
  "uid": string,
  "phaseId": string,
  "jobId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "etag": string,

  // Union field job_run can be only one of the following:
  "deployJobRun": {
    object (DeployJobRun)
  },
  "verifyJobRun": {
    object (VerifyJobRun)
  },
  "predeployJobRun": {
    object (PredeployJobRun)
  },
  "postdeployJobRun": {
    object (PostdeployJobRun)
  },
  "createChildRolloutJobRun": {
    object (CreateChildRolloutJobRun)
  },
  "advanceChildRolloutJobRun": {
    object (AdvanceChildRolloutJobRun)
  }
  // End of list of possible types for union field job_run.
}
Felder
name

string

Optional. Name von JobRun. Das Format ist projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
uid

string

Nur Ausgabe. Eindeutige Kennung von JobRun.
phaseId

string

Nur Ausgabe. ID der Rollout-Phase, zu der diese JobRun gehört.
jobId

string

Nur Ausgabe. ID des Rollout-Jobs, dem diese JobRun entspricht.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem das JobRun 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".
startTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem der JobRun gestartet 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".
endTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem der JobRun endete.

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".
state

enum (State)

Nur Ausgabe. Der aktuelle Status von JobRun.
etag

string

Nur Ausgabe. 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.
Union-Feld job_run. Der Typ JobRun und die Informationen zu diesem Typ. Für job_run ist nur einer der folgenden Werte zulässig:
deployJobRun

object (DeployJobRun)

Nur Ausgabe. Spezifische Informationen für eine Bereitstellungs-JobRun.
verifyJobRun

object (VerifyJobRun)

Nur Ausgabe. Spezifische Informationen zur Bestätigung JobRun.
predeployJobRun

object (PredeployJobRun)

Nur Ausgabe. Spezifische Informationen für eine vorab bereitgestellte JobRun.
postdeployJobRun

object (PostdeployJobRun)

Nur Ausgabe. Spezifische Informationen für eine nach dem Deployment bereitgestellte JobRun.
createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Nur Ausgabe. Spezifische Informationen für createChildRollout-JobRun.
advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Nur Ausgabe. Spezifische Informationen für PreferredChildRollout JobRun

Status

Gültige Statuswerte für JobRun.

Enums
STATE_UNSPECIFIED Der Status der JobRun ist nicht spezifiziert.
IN_PROGRESS JobRun wird ausgeführt.
SUCCEEDED JobRun ist erfolgreich.
FAILED Fehler beim JobRun.
TERMINATING JobRun wird beendet.
TERMINATED JobRun wurde geschlossen.

DeployJobRun

DeployJobRun enthält Informationen speziell zu einer Bereitstellungs-JobRun.

JSON-Darstellung 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
Felder
build

string

Nur Ausgabe. Der Ressourcenname des Build-Objekts von Cloud Build, das für die Bereitstellung verwendet wird. Das Format ist projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Nur Ausgabe. Der Grund für die fehlgeschlagene Bereitstellung. Dies ist immer nicht angegeben, während die Bereitstellung ausgeführt wird oder wenn sie erfolgreich war.
failureMessage

string

Nur Ausgabe. Zusätzliche Informationen zum Bereitstellungsfehler, falls verfügbar.
metadata

object (DeployJobRunMetadata)

Nur Ausgabe. Metadaten mit Informationen zur Ausführung des Bereitstellungsjobs.
artifact

object (DeployArtifact)

Nur Ausgabe. Das Artefakt eines Bereitstellungsjobs, der verfügbar ist.

FailureCause

Bekannte Fehler bei der Bereitstellung.

Enums
FAILURE_CAUSE_UNSPECIFIED Es wurde kein Grund für den Fehler angegeben.
CLOUD_BUILD_UNAVAILABLE Cloud Build ist nicht verfügbar, weil es nicht aktiviert ist oder Cloud Deploy unzureichende Berechtigungen hat. Siehe Erforderliche Berechtigung.
EXECUTION_FAILED Der Bereitstellungsvorgang wurde nicht erfolgreich abgeschlossen. Prüfen Sie die Cloud Build-Logs.
DEADLINE_EXCEEDED Der Bereitstellungsjob wurde nicht innerhalb der vorgesehenen Zeit ausgeführt.
MISSING_RESOURCES_FOR_CANARY In der Laufzeitumgebung fehlen Ressourcen, die für ein Canary-Deployment erforderlich sind. Weitere Informationen finden Sie in den Cloud Build-Logs.
CLOUD_BUILD_REQUEST_FAILED Cloud Build konnte die Anfrage von Cloud Deploy nicht ausführen. Weitere Informationen finden Sie unter „failMessage“.
DEPLOY_FEATURE_NOT_SUPPORTED Für den Bereitstellungsvorgang war ein Feature konfiguriert, das nicht unterstützt wird.

DeployJobRunMetadata

Mit DeployJobRunMetadata werden dem Nutzer Informationen angezeigt, die mit einem DeployJobRun verknüpft sind.

JSON-Darstellung 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Felder
cloudRun

object (CloudRunMetadata)

Nur Ausgabe. Der Name des Cloud Run-Dienstes, der einem DeployJobRun zugeordnet ist.
customTarget

object (CustomTargetDeployMetadata)

Nur Ausgabe. Benutzerdefinierte Zielmetadaten, die mit einer DeployJobRun verknüpft sind.
custom

object (CustomMetadata)

Nur Ausgabe. Benutzerdefinierte Metadaten, die durch einen benutzerdefinierten Bereitstellungsvorgang bereitgestellt werden.

CustomTargetDeployMetadata

CustomTargetDeployMetadata enthält Informationen aus einem Bereitstellungsvorgang für ein benutzerdefiniertes Ziel.

JSON-Darstellung 
{
  "skipMessage": string
}
Felder
skipMessage

string

Nur Ausgabe. Überspringen Sie die Nachricht, die in den Ergebnissen eines benutzerdefinierten Bereitstellungsvorgangs angegeben wird.

DeployArtifact

Die Artefakte, die von einem Bereitstellungsvorgang erzeugt werden.

JSON-Darstellung 
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Felder
artifactUri

string

Nur Ausgabe. URI eines Verzeichnisses, das die Artefakte enthält. Alle Pfade beziehen sich auf diesen Speicherort.
manifestPaths[]

string

Nur Ausgabe. Dateipfade der Manifeste, die während des Bereitstellungsvorgangs angewendet wurden, relativ zum URI.

VerifyJobRun

VerifyJobRun enthält Informationen speziell zu einer Überprüfungs-JobRun.

JSON-Darstellung 
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Felder
build

string

Nur Ausgabe. Der Ressourcenname des Cloud Build-Objekts Build, das für die Überprüfung verwendet wird. Das Format ist projects/{project}/locations/{location}/builds/{build}.
artifactUri

string

Nur Ausgabe. URI eines Verzeichnisses, das die Überprüfungsartefakte enthält. Enthält das Skaffold-Ereignisprotokoll.
eventLogPath

string

Nur Ausgabe. Dateipfad des Skaffold-Ereignisprotokolls relativ zum Artefakt-URI.
failureCause

enum (FailureCause)

Nur Ausgabe. Der Grund, warum die Bestätigung fehlgeschlagen ist. Dies ist immer nicht angegeben, während die Überprüfung läuft oder wenn sie erfolgreich war.
failureMessage

string

Nur Ausgabe. Zusätzliche Informationen zum Fehler bei der Verifizierung, falls verfügbar.

FailureCause

Bekannte Fehler bei der Verifizierung.

Enums
FAILURE_CAUSE_UNSPECIFIED Es wurde kein Grund für den Fehler angegeben.
CLOUD_BUILD_UNAVAILABLE Cloud Build ist nicht verfügbar, weil es nicht aktiviert ist oder Cloud Deploy unzureichende Berechtigungen hat. Siehe Erforderliche Berechtigung.
EXECUTION_FAILED Der Verifizierungsvorgang wurde nicht erfolgreich abgeschlossen. Prüfen Sie die Cloud Build-Logs.
DEADLINE_EXCEEDED Die Überprüfung des Jobs wurde nicht innerhalb der vorgegebenen Zeit abgeschlossen.
VERIFICATION_CONFIG_NOT_FOUND Es wurde keine Skaffold-Überprüfungskonfiguration gefunden.
CLOUD_BUILD_REQUEST_FAILED Cloud Build konnte die Anfrage von Cloud Deploy nicht ausführen. Weitere Informationen finden Sie unter „failMessage“.

PredeployJobRun

PredeployJobRun enthält Informationen speziell für eine vorab bereitgestellte JobRun.

JSON-Darstellung 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Felder
build

string

Nur Ausgabe. Der Ressourcenname des Build-Objekts in Cloud Build, mit dem die benutzerdefinierten Aktionen ausgeführt werden, die mit dem Vorbereitstellungsjob verknüpft sind. Das Format ist projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Nur Ausgabe. Der Grund für die fehlgeschlagene Vorbereitstellung. Dies ist immer nicht angegeben, während die Vorabbereitstellung läuft oder wenn sie erfolgreich war.
failureMessage

string

Nur Ausgabe. Zusätzliche Informationen zum Fehler vor der Bereitstellung, falls verfügbar.

FailureCause

Bekannte Fehler bei der Vorbereitstellung.

Enums
FAILURE_CAUSE_UNSPECIFIED Es wurde kein Grund für den Fehler angegeben.
CLOUD_BUILD_UNAVAILABLE Cloud Build ist nicht verfügbar, weil es nicht aktiviert ist oder Cloud Deploy unzureichende Berechtigungen hat. Siehe Erforderliche Berechtigung.
EXECUTION_FAILED Der Vorgang vor der Bereitstellung wurde nicht erfolgreich abgeschlossen. Prüfen Sie die Cloud Build-Logs.
DEADLINE_EXCEEDED Die Ausführung des Vorab-Bereitstellungsjobs wurde nicht innerhalb der vorgesehenen Zeit abgeschlossen.
CLOUD_BUILD_REQUEST_FAILED Cloud Build konnte die Anfrage von Cloud Deploy nicht ausführen. Weitere Informationen finden Sie unter „failMessage“.

PostdeployJobRun

PostdeployJobRun enthält Informationen speziell für einen postdeploy-JobRun.

JSON-Darstellung 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Felder
build

string

Nur Ausgabe. Der Ressourcenname des Build-Objekts in Cloud Build, mit dem die benutzerdefinierten Aktionen ausgeführt werden, die mit dem Postdeploy-Job verknüpft sind. Das Format ist projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Nur Ausgabe. Der Grund, warum das Postdeploy fehlgeschlagen ist. Dies ist immer nicht angegeben, während das Postdeploy läuft oder wenn es erfolgreich war.
failureMessage

string

Nur Ausgabe. Zusätzliche Informationen zum Fehler nach dem Deployment, falls verfügbar.

FailureCause

Bekannte Fehler nach der Bereitstellung.

Enums
FAILURE_CAUSE_UNSPECIFIED Es wurde kein Grund für den Fehler angegeben.
CLOUD_BUILD_UNAVAILABLE Cloud Build ist nicht verfügbar, weil es nicht aktiviert ist oder Cloud Deploy unzureichende Berechtigungen hat. Siehe Erforderliche Berechtigung.
EXECUTION_FAILED Der Postdeploy-Vorgang wurde nicht erfolgreich abgeschlossen. Prüfen Sie die Cloud Build-Logs.
DEADLINE_EXCEEDED Der Postdeploy-Job wurde nicht innerhalb der vorgegebenen Zeit ausgeführt.
CLOUD_BUILD_REQUEST_FAILED Cloud Build konnte die Anfrage von Cloud Deploy nicht ausführen. Weitere Informationen finden Sie unter „failMessage“.

CreateChildRolloutJobRun

CreateChildRolloutJobRun enthält Informationen speziell für createChildRollout-JobRun.

JSON-Darstellung 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Felder
rollout

string

Nur Ausgabe. Name von ChildRollout. Das Format ist projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Nur Ausgabe. Die ID der ChildrenRollout-Phase, die von diesem JobRun initiiert wurde.

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun enthält Informationen, die sich auf ein PreferredChildRollout-JobRun-Objekt beziehen.

JSON-Darstellung 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Felder
rollout

string

Nur Ausgabe. Name von ChildRollout. Das Format ist projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Nur Ausgabe. Die ID der ChildRollout-Phase.

Methoden

get

 Ruft Details zu einem einzelnen JobRun ab.

list

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

terminate

 Beendet eine Jobausführung in einem bestimmten Projekt und an einem bestimmten Standort.