Workflow ausführen

Bei der Ausführung eines Workflows wird die aktuelle Workflowdefinition ausgeführt, die dem Workflow zugeordnet ist.

Sie können Laufzeitargumente in einer Anfrage zur Workflowausführung übergeben und mithilfe einer Workflowvariablen auf diese Argumente zugreifen. Weitere Informationen finden Sie unter Laufzeitargumente in einer Ausführungsanfrage übergeben.

Nach Abschluss einer Workflowausführung werden der Verlauf und die Ergebnisse für einen begrenzten Zeitraum gespeichert. Weitere Informationen finden Sie unter Kontingente und Limits.

Hinweise

Von Ihrer Organisation definierte Sicherheitsbeschränkungen verhindern möglicherweise, dass die folgenden Schritte ausgeführt werden. Informationen zur Fehlerbehebung finden Sie unter Anwendungen in einer eingeschränkten Google Cloud -Umgebung entwickeln.

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Wenn ein Workflow auf andere Google Cloud Ressourcen zugreift, muss er einem Dienstkonto zugeordnet werden, das die richtigen Berechtigungen hat. Informationen dazu, welches Dienstkonto einem vorhandenen Workflow zugeordnet ist, finden Sie unter Verknüpftes Dienstkonto eines Workflows prüfen.

    Hinweis: Um eine Ressource zu erstellen und ein Dienstkonto anzuhängen, benötigen Sie Berechtigungen zum Erstellen dieser Ressource und die Erlaubnis, sich als das Dienstkonto auszugeben, das Sie an die Ressource anhängen werden. Weitere Informationen finden Sie unter Dienstkontoberechtigungen.

  7. Stellen Sie einen Workflow mit der Google Cloud -Konsole oder der Google Cloud CLI bereit.

    8. Workflow ausführen

    Sie haben folgende Möglichkeiten, einen Workflow auszuführen:

    • In der Google Cloud Console
    • Über die Google Cloud CLI in Ihrem Terminal oder in Cloud Shell
    • Direkte Anfrage an die Workflows API senden

    Sie können einen Workflow auch mit den Cloud-Clientbibliotheken ausführen. Weitere Informationen finden Sie unter Workflow mit den Cloud-Clientbibliotheken ausführen.

    Console

    1. Rufen Sie zum Ausführen eines Workflows in der Google Cloud Console die Seite Workflows auf:

      Zur Seite "Workflows"

    2. Wählen Sie auf der Seite Workflows einen Workflow aus, um dessen Detailseite aufzurufen.

    3. Klicken Sie auf der Seite Workflow-Details auf  Ausführen.

    4. Auf der Seite Workflow ausführen können Sie im Bereich Eingabe optionale Laufzeitargumente eingeben, die vor der Ausführung an Ihren Workflow übergeben werden. Argumente müssen im JSON-Format vorliegen. Beispiel: {"animal":"cat"}. Wenn Ihr Workflow keine Laufzeitargumente verwendet, lassen Sie dieses Feld leer.

    5. Geben Sie optional die Ebene des Aufruf-Loggings an, die Sie auf die Ausführung des Workflows anwenden möchten. Wählen Sie in der Liste Anruflogebene eine der folgenden Optionen aus:

      • Nicht angegeben: Es wird keine Logging-Ebene angegeben. Das ist die Standardeinstellung. Eine Ausführungslogebene hat Vorrang vor einer Workflow-Logebene, sofern keine Ausführungslogebene angegeben ist (Standardeinstellung); In diesem Fall wird die Workflow-Logebene genutzt.
      • Nur Fehler: Alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme werden protokolliert.
      • Alle Aufrufe: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
      • Keine Logs: Es werden keine Anrufe protokolliert.

    6. Geben Sie optional die Ebene des Ausführungsverlaufs an, die Sie auf die Ausführung des Workflows anwenden möchten. Wählen Sie in der Liste Ausführungsverlauf eine der folgenden Optionen aus:

      • Von Workflow übernehmen: Die Einstellung für den Ausführungsverlauf des Workflows wird angewendet. Das ist die Standardeinstellung.
      • Basic: Aktiviert den einfachen Ausführungsverlauf.
      • Detailliert: Aktiviert den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.

    7. Klicken Sie auf Ausführen.

    8. Auf der Seite Ausführungsdetails können Sie die Ergebnisse der Ausführung ansehen, einschließlich aller Ausgaben, der Ausführungs-ID und des Ausführungsstatus sowie des aktuellen oder letzten Schritts der Workflowausführung. Weitere Informationen finden Sie unter Auf Workflow-Ausführungsergebnisse zugreifen.

    gcloud

    1. Öffnen Sie ein Terminalfenster.

    2. Suchen Sie den Namen des Workflows, den Sie ausführen möchten. Wenn Sie den Namen des Workflows nicht kennen, können Sie den folgenden Befehl eingeben, um alle Workflows aufzulisten:

      gcloud workflows list

    3. Sie können den Workflow entweder mit dem Befehl gcloud workflows run oder mit dem Befehl gcloud workflows execute ausführen:

      • Führen Sie den Workflow aus und warten Sie, bis die Ausführung abgeschlossen ist:

        gcloud workflows run WORKFLOW_NAME \
    --call-log-level=CALL_LOGGING_LEVEL \
    --execution-history-level="EXECUTION_HISTORY_LEVEL" \
    --data=DATA

      • Führen Sie den Workflow aus, ohne auf den Abschluss des Ausführungsversuchs zu warten:

        gcloud workflows execute WORKFLOW_NAME \
    --call-log-level=CALL_LOGGING_LEVEL \
    --execution-history-level="EXECUTION_HISTORY_LEVEL" \
    --data=DATA

        Ersetzen Sie Folgendes:

        • WORKFLOW_NAME: Der Name des Workflows.

        • CALL_LOGGING_LEVEL (optional): Ebene des Aufruf-Loggings, das während der Ausführung angewendet werden soll. Kann einer der folgenden Werte sein:

          • none: Es wird keine Logging-Ebene angegeben. Das ist die Standardeinstellung. Eine Ausführungslogebene hat Vorrang vor einer Workflow-Logebene, sofern keine Ausführungslogebene angegeben ist (Standardeinstellung); In diesem Fall wird die Workflow-Logebene genutzt.
          • log-errors-only: Es werden alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme protokolliert
          • log-all-calls: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
          • log-none: Kein Aufruf-Logging.

        • EXECUTION_HISTORY_LEVEL (optional): Ebene des Ausführungsverlaufs, die während der Ausführung angewendet werden soll. Kann einer der folgenden Werte sein:

          • none: Es wird keine Ausführlichkeitsstufe für den Ausführungsverlauf angegeben. Das ist die Standardeinstellung. Wenn für eine Ausführung keine Ausführungshistorieebene angegeben ist, wird sie durch die auf den Workflow angewendete Ebene bestimmt. Wenn sich die Ebenen unterscheiden, wird die Einstellung, die auf Ausführungsebene angewendet wird, für diese Ausführung durch die Einstellung auf Workflowebene überschrieben.
          • execution-history-basic: Aktivieren Sie den einfachen Ausführungsverlauf.
          • execution-history-detailed: Ermöglicht einen detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.

        • DATA (optional): Laufzeitargumente für Ihren Workflow im JSON-Format.

    4. Wenn Sie gcloud workflows execute ausgeführt haben, wird die eindeutige ID des Workflow-Ausführungsversuchs zurückgegeben und die Ausgabe sieht in etwa so aus:

       To view the workflow status, you can use following command:
 gcloud workflows executions describe b113b589-8eff-4968-b830-8d35696f0b33 --workflow workflow-2 --location us-central1

      Geben Sie den im vorherigen Schritt zurückgegebenen Befehl ein, um den Status der Ausführung aufzurufen.

    Wenn der Ausführungsversuch erfolgreich ist, sieht die Ausgabe in etwa so aus. Das state gibt an, dass der Workflow erfolgreich ausgeführt wurde, und das status gibt den letzten Workflowschritt der Ausführung an. 

    argument: '{"searchTerm":"Friday"}'
endTime: '2022-06-22T12:17:53.086073678Z'
name: projects/1051295516635/locations/us-central1/workflows/myFirstWorkflow/executions/c4dffd1f-13db-46a0-8a4a-ee39c144cb96
result: '["Friday","Friday the 13th (franchise)","Friday Night Lights (TV series)","Friday
    the 13th (1980 film)","Friday the 13th","Friday the 13th (2009 film)","Friday the
    13th Part III","Friday the 13th Part 2","Friday (Rebecca Black song)","Friday Night
    Lights (film)"]'
startTime: '2022-06-22T12:17:52.799387653Z'
state: SUCCEEDED
status:
    currentSteps:
    - routine: main
        step: returnOutput
workflowRevisionId: 000001-ac2

    REST API

    Verwenden Sie die Methode projects.locations.workflows.executions.create, um eine neue Ausführung mit der neuesten Überarbeitung eines bestimmten Workflows zu erstellen.

    Ersetzen Sie diese Werte in den folgenden Anfragedaten:

    • PROJECT_NUMBER: Ihre Google Cloud-Projektnummer, die auf der Seite IAM & Verwaltung > Einstellungen aufgeführt ist.
    • LOCATION: die Region, in der der Workflow bereitgestellt wird, z. B. us-central1.
    • WORKFLOW_NAME: Der benutzerdefinierte Name für den Workflow, z. B. myFirstWorkflow.
    • PARAMETER: Optional. Wenn der Workflow, den Sie ausführen, Laufzeitargumente empfangen kann, die Sie ihm im Rahmen einer Ausführungsanfrage übergeben, können Sie dem Anfragetext einen JSON-formatierten String hinzufügen, dessen Wert ein oder mehrere Escape-Parameter-Wert-Paare ist, z. B. "{\"searchTerm\":\"asia\"}".
    • VALUE: Optional. Der Wert eines Parameter-Wert-Paars, das Ihr Workflow als Laufzeitargument empfangen kann.
    • CALL_LOGGING_LEVEL: Optional. Die Ebene des Aufruf-Loggings, die während der Ausführung angewendet werden soll. Standardmäßig wird keine Logging-Ebene angegeben und stattdessen die Workflow-Logebene angewendet. Weitere Informationen finden Sie unter Logs an Logging senden. Einer der folgenden Werte:
      • CALL_LOG_LEVEL_UNSPECIFIED: Es wird keine Logging-Ebene angegeben und stattdessen die Workflow-Logebene angewendet. Das ist die Standardeinstellung. Andernfalls gilt die Ausführungslogebene und hat Vorrang vor der Workflow-Logebene.
      • LOG_ERRORS_ONLY: Es werden alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme protokolliert.
      • LOG_ALL_CALLS: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
      • LOG_NONE: Kein Aufruf-Logging.
    • BACKLOG_EXECUTION: Optional. Wenn true festgelegt ist, wird die Ausführung nicht zurückgestellt, wenn das Kontingent für die Parallelität erschöpft ist. Weitere Informationen finden Sie unter Ausführungsrückstände verwalten.
    • EXECUTION_HISTORY_LEVEL: Optional. Die Ausführlichkeitsstufe für den Ausführungsverlauf, die während der Ausführung angewendet werden soll. Weitere Informationen finden Sie unter Verlauf der Ausführungsschritte ansehen. Einer der folgenden Werte:
      • EXECUTION_HISTORY_LEVEL_UNSPECIFIED: Es wird keine Ausführlichkeitsstufe für den Ausführungsverlauf angegeben. Das ist die Standardeinstellung. Wenn für eine Ausführung keine Ausführungsverlaufsebene angegeben ist, wird sie durch die Ebene bestimmt, die auf den Workflow angewendet wird. Wenn die Ebenen unterschiedlich sind, wird die Einstellung, die auf Ausführungsebene angewendet wird, für diese Ausführung durch die Einstellung auf Workflowebene überschrieben.
      • EXECUTION_HISTORY_BASIC: Aktivieren Sie den einfachen Ausführungsverlauf.
      • EXECUTION_HISTORY_ADVANCED: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.

    JSON-Text der Anfrage:

    {
  "argument": "{\"PARAMETER\":\"VALUE\"}",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "disableConcurrencyQuotaOverflowBuffering": "BACKLOG_EXECUTION",
  "executionHistoryLevel": "EXECUTION_HISTORY_LEVEL"
}

    Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

    Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Execution: 

    {
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_NAME/executions/EXECUTION_ID",
  "startTime": "2023-11-07T14:35:27.215337069Z",
  "state": "ACTIVE",
  "argument": "{\"PARAMETER\":\"VALUE\"}",
  "workflowRevisionId": "000001-2df",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "executionHistoryLevel": "EXECUTION_HISTORY_LEVEL",
  "status": {}
}

    Status von Ausführungen prüfen

    Es gibt mehrere Befehle, mit denen Sie den Status einer Workflowausführung prüfen können.

    • Geben Sie den folgenden Befehl ein, um eine Liste der Ausführungsversuche eines Workflows und ihrer IDs abzurufen:

      gcloud workflows executions list WORKFLOW_NAME

      Ersetzen Sie WORKFLOW_NAME durch den Namen des Workflows.

      Der Befehl gibt einen NAME-Wert zurück, der dem folgenden ähnelt:

      projects/PROJECT_NUMBER/locations/REGION/workflows/WORKFLOW_NAME/executions/EXECUTION_ID

      Kopieren Sie die Ausführungs-ID, um sie im nächsten Befehl zu verwenden.

    • Geben Sie den folgenden Befehl ein, um den Status eines Ausführungsversuchs zu prüfen und auf den Abschluss des Versuchs zu warten:

      gcloud workflows executions wait EXECUTION_ID

      Ersetzen Sie EXECUTION_ID durch die ID des Ausführungsversuchs.

      Der Befehl wartet, bis der Ausführungsversuch abgeschlossen ist, und gibt dann die Ergebnisse zurück.

    • Geben Sie den folgenden Befehl ein, um zu warten, bis die letzte Ausführung abgeschlossen ist, und dann das Ergebnis der abgeschlossenen Ausführung zurückzugeben:

      gcloud workflows executions wait-last

      Wenn Sie einen vorherigen Ausführungsversuch in derselben gcloud-Sitzung durchgeführt haben, wartet der Befehl auf den Abschluss des vorherigen Ausführungsversuchs und gibt dann die Ergebnisse der abgeschlossenen Ausführung zurück. Wenn kein vorheriger Versuch vorhanden ist, gibt gcloud den folgenden Fehler zurück:

      ERROR: (gcloud.workflows.executions.wait-last) [NOT FOUND] There are no cached executions available.

    • Geben Sie den folgenden Befehl ein, um den Status der letzten Ausführung abzurufen:

      gcloud workflows executions describe-last

      Wenn Sie in derselben gcloud-Sitzung einen vorherigen Ausführungsversuch ausgeführt haben, gibt der Befehl die Ergebnisse der letzten Ausführung zurück, auch wenn sie noch läuft. Wenn kein vorheriger Versuch vorhanden ist, gibt gcloud den folgenden Fehler zurück:

      ERROR: (gcloud.beta.workflows.executions.describe-last) [NOT FOUND] There are no cached executions available.

    Filterausführungen

    Sie können Filter auf die Liste der Workflow-Ausführungen anwenden, die von der Methode workflows.executions.list zurückgegeben werden.

    Sie können nach den folgenden Feldern filtern:

    • createTime
    • disableOverflowBuffering
    • duration
    • endTime
    • executionId
    • label
    • startTime
    • state
    • stepName
    • workflowRevisionId

    Wenn Sie beispielsweise nach einem Label (labels."fruit":"apple") filtern möchten, können Sie eine API-Anfrage ähnlich der folgenden stellen:

    GET https://workflowexecutions.googleapis.com/v1/projects/MY_PROJECT/locations/MY_LOCATION/workflows/MY_WORKFLOW/executions?view=full&filter=labels.%22fruit%22%3A%22apple%22"

    Wobei:

    • view=full gibt eine Ansicht an, die definiert, welche Felder in den zurückgegebenen Ausführungen ausgefüllt werden sollen. In diesem Fall sind es alle Daten.
    • labels.%22fruit%22%3A%22apple%22ist die URL-codierte Filtersyntax.

    Weitere Informationen finden Sie unter AIP-160 – Filtern.

    Verwaltung von Ausführungsrückständen

    Mit der Ausführungs-Backlog-Funktion können Sie clientseitige Wiederholungsversuche vermeiden, Ausführungsverzögerungen beseitigen und den Durchsatz maximieren. Ausführungen, die sich im Rückstand befinden, werden automatisch ausgeführt, sobald das Kontingent für die Ausführungsnebenläufigkeit verfügbar ist.

    Es gibt eine maximale Anzahl aktiver Workflowausführungen, die gleichzeitig ausgeführt werden können. Wenn dieses Kontingent aufgebraucht ist und die Ausführung von Backlogs deaktiviert ist oder das Kontingent für Backlog-Ausführungen erreicht ist, schlagen alle neuen Ausführungen mit dem HTTP-Statuscode 429 Too many requests fehl. Wenn die Ausführungswarteschlange aktiviert ist, werden die neuen Ausführungen erfolgreich ausgeführt und im Status QUEUED erstellt. Sobald das Kontingent für die Ausführungskonkurrenz verfügbar ist, werden die Ausführungen automatisch ausgeführt und wechseln in den Status ACTIVE.

    Standardmäßig ist die Ausführungsrückstellung für alle Anfragen aktiviert, einschließlich der von Cloud Tasks ausgelösten Anfragen, mit den folgenden Ausnahmen:

    • Wenn Sie eine Ausführung mit einem executions.run- oder executions.create-Connector in einem Workflow erstellen, ist die Ausführungsrückstandsbearbeitung standardmäßig deaktiviert. Sie können sie konfigurieren, indem Sie das Feld disableConcurrencyQuotaOverflowBuffering der Ausführung explizit auf false setzen.
    • Bei Ausführungen, die durch Pub/Sub ausgelöst werden, ist die Rückstandsbearbeitung deaktiviert und kann nicht konfiguriert werden.

    Wichtige Hinweise:

    • Ausführungen in der Warteschlange werden nach dem FIFO-Prinzip (First-In-First-Out) auf Best-Effort-Basis gestartet.
    • Das Zeitstempelfeld createTime gibt an, wann eine Ausführung erstellt wurde. Der Zeitstempel startTime gibt an, wann eine Ausführung automatisch aus der Backlog-Warteschlange entfernt und gestartet wird. Bei Ausführungen, die nicht im Rückstand sind, sind beide Zeitstempelwerte identisch.
    • Das Limit für zurückgestellte Ausführungen kann mit dem Kontingentmesswert workflowexecutions.googleapis.com/executionbacklogentries beobachtet werden. Weitere Informationen finden Sie unter Kontingente aufrufen und verwalten.

    Ausführung von Backlogs deaktivieren

    Sie können die Ausführungs-Backlogs deaktivieren, indem Sie ein Flag festlegen, wenn Sie die Google Cloud CLI verwenden. Beispiel:

    gcloud workflows execute WORKFLOW_NAME
    --disable-concurrency-quota-overflow-buffering

    Alternativ können Sie die Ausführung von Backlogs deaktivieren, indem Sie das Feld disableConcurrencyQuotaOverflowBuffering im JSON-Anfragetext auf true setzen, wenn Sie eine Ausführungsanfrage an die Workflows REST API senden. Beispiel:

    {
  "argument": {"arg1":"value1"},
  "callLogLevel": "LOG_NONE",
  "disableConcurrencyQuotaOverflowBuffering": true
}

    Weitere Informationen finden Sie unter Workflow ausführen.

    Nächste Schritte