Workflows erstellen und verwalten

Sie können Workflows in der Google Cloud Console oder mit der Google Cloud CLI in Ihrem Terminal oder in Cloud Shell erstellen und verwalten. Sie können Workflows auch über die Workflows API verwalten.

Hinweis

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.

Console

  1. Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie mit Google Cloudnoch nicht vertraut sind, erstellen Sie einfach ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Workflows API, if it is not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Workflows API, if it is not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

    8.

gcloud

  1. Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie mit Google Cloudnoch nicht vertraut sind, erstellen Sie einfach ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

  2. Installieren Sie die Google Cloud CLI.

  3. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  4. Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren: 

    gcloud init

  5. Erstellen Sie ein Google Cloud Projekt oder wählen Sie eines aus.

    Erforderliche Rollen zum Auswählen oder Erstellen eines Projekts

    • Projekt auswählen: Für die Auswahl eines Projekts ist keine bestimmte IAM-Rolle erforderlich. Sie können jedes Projekt auswählen, für das Ihnen eine Rolle zugewiesen wurde.
    • Projekt erstellen: Zum Erstellen eines Projekts benötigen Sie die Rolle „Projektersteller“ (roles/resourcemanager.projectCreator), die die Berechtigung resourcemanager.projects.create enthält. Weitere Informationen zum Zuweisen von Rollen

    • So erstellen Sie ein Google Cloud Projekt:

      gcloud projects create PROJECT_ID

      Ersetzen Sie PROJECT_ID durch einen Namen für das Google Cloud Projekt, das Sie erstellen.

    • Wählen Sie das von Ihnen erstellte Google Cloud Projekt aus:

      gcloud config set project PROJECT_ID

      Ersetzen Sie PROJECT_ID durch Ihren Google Cloud Projektnamen.

  6. Prüfen Sie, ob die Abrechnung für Ihr Google Cloud Projekt aktiviert ist.

  7. Aktivieren Sie die Workflows API, falls sie noch nicht aktiviert ist:

    Rollen, die zum Aktivieren von APIs erforderlich sind

    Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen 

    gcloud services enable workflows.googleapis.com

  8. Installieren Sie die Google Cloud CLI.

  9. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  10. Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren: 

    gcloud init

  11. Erstellen Sie ein Google Cloud Projekt oder wählen Sie eines aus.

    Erforderliche Rollen zum Auswählen oder Erstellen eines Projekts

    • Projekt auswählen: Für die Auswahl eines Projekts ist keine bestimmte IAM-Rolle erforderlich. Sie können jedes Projekt auswählen, für das Ihnen eine Rolle zugewiesen wurde.
    • Projekt erstellen: Zum Erstellen eines Projekts benötigen Sie die Rolle „Projektersteller“ (roles/resourcemanager.projectCreator), die die Berechtigung resourcemanager.projects.create enthält. Weitere Informationen zum Zuweisen von Rollen

    • So erstellen Sie ein Google Cloud Projekt:

      gcloud projects create PROJECT_ID

      Ersetzen Sie PROJECT_ID durch einen Namen für das Google Cloud Projekt, das Sie erstellen.

    • Wählen Sie das von Ihnen erstellte Google Cloud Projekt aus:

      gcloud config set project PROJECT_ID

      Ersetzen Sie PROJECT_ID durch Ihren Google Cloud Projektnamen.

  12. Prüfen Sie, ob die Abrechnung für Ihr Google Cloud Projekt aktiviert ist.

  13. Aktivieren Sie die Workflows API, falls sie noch nicht aktiviert ist:

    Rollen, die zum Aktivieren von APIs erforderlich sind

    Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen 

    gcloud services enable workflows.googleapis.com
    14.

REST

Wenn Sie Workflows mit der Workflows API verwalten möchten, empfehlen wir, die von Google bereitgestellten Clientbibliotheken zu verwenden, um den workflows.googleapis.com-Dienst aufzurufen. Weitere Informationen finden Sie unter Workflows API.

Dienstkonto erstellen

Ein Dienstkonto stellt die Identität eines Workflows dar und bestimmt, welche Berechtigungen der Workflow hat und auf welche Google Cloud Ressourcen er zugreifen kann. Erstellen Sie ein Dienstkonto, falls Sie noch keines haben, und weisen Sie ihm dann die erforderlichen Rollen zum Verwalten von Workflows und Erstellen von Logs zu.

Wenn Sie beim Erstellen des Workflows kein Dienstkonto angeben, verwendet der Workflow das Compute Engine-Standarddienstkonto für seine Identität. Weitere Informationen finden Sie unter Zugriff auf Google Cloud -Ressourcen für einen Workflow gewähren.

Es wird dringend empfohlen, ein Dienstkonto mit den geringsten Berechtigungen zu verwenden, die für den Zugriff auf die erforderlichen Ressourcen erforderlich sind.

Zum Erstellen einer Ressource und Anhängen eines Dienstkontos benötigen Sie Berechtigungen zum Erstellen der Ressource und zum Übernehmen der Identität des Dienstkontos, das Sie an die Ressource anhängen. Weitere Informationen finden Sie unter Dienstkontoberechtigungen.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Dienstkonten auf.

    Zur Seite „Dienstkonten“

  2. Wählen Sie ein Projekt aus und klicken Sie auf Dienstkonto erstellen.

  3. Geben Sie im Feld Dienstkontoname einen Namen ein.

    Der Name muss zwischen 6 und 30 Zeichen lang sein und alphanumerische Zeichen in Kleinschreibung sowie Bindestriche enthalten. Nachdem Sie ein Dienstkonto erstellt haben, können Sie den Namen nicht mehr ändern.

  4. Klicken Sie auf Erstellen und fortfahren.

  5. Klicken Sie auf Rolle auswählen.

  6. Wählen Sie die folgenden Rollen aus und klicken Sie bei Bedarf auf Weitere Rolle hinzufügen:

    1. Wenn Sie Workflows erstellen, aktualisieren und ausführen möchten, wählen Sie Workflows > Workflow-Editor aus.
    2. Wenn Sie Logs an Cloud Logging senden möchten, wählen Sie Logging > Logautor aus.

  7. Klicken Sie auf Fertig, um das Erstellen des Dienstkontos abzuschließen.

gcloud

  1. Erstellen Sie das Dienstkonto.

    gcloud iam service-accounts create SERVICE_ACCOUNT

  2. Gewähren Sie dem Dienstkonto Berechtigungen, indem Sie Rollen zuweisen.

    1. Weisen Sie die Rolle roles/workflows.editor zu, um Workflows zu erstellen, zu aktualisieren und auszuführen:

      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/workflows.editor"

    2. Weisen Sie die Rolle roles/logging.logWriter zu, um Logs an Cloud Logging zu senden:

      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/logging.logWriter"

    Ersetzen Sie Folgendes:

    • SERVICE_ACCOUNT: der Name des Dienstkontos. Der Name des Dienstkontos muss zwischen 6 und 30 Zeichen lang sein und darf alphanumerische Zeichen in Kleinschreibung sowie Bindestriche enthalten. Nachdem Sie ein Dienstkonto erstellt haben, können Sie den Namen nicht mehr ändern.

    • PROJECT_ID: die ID Ihres Projekts.

REST

Sie können die Methode serviceAccounts.create verwenden, um ein Dienstkonto zu erstellen. Weitere Informationen finden Sie unter Dienstkonten erstellen.

Sie können programmatisch mehrere Rollen zuweisen, indem Sie die Zulassungsrichtlinie für eine Ressource mit der Methode setIamPolicy ändern und festlegen. Weitere Informationen finden Sie unter Mehrere Rollen programmatisch zuweisen oder widerrufen.

Workflow erstellen

Ein Workflow besteht aus einer Reihe von Schritten, die mit der Workflows-Syntax beschrieben werden. Diese kann entweder im YAML- oder JSON-Format geschrieben werden. Nachdem Sie einen Workflow definiert haben, stellen Sie ihn bereit, damit er ausgeführt werden kann. Der Bereitstellungsschritt überprüft auch, ob die Quelldatei ausgeführt werden kann. Es schlägt fehl, wenn die Quelldatei keine gültige Workflowdefinition enthält.

Das Bearbeiten von YAML-Dateien kann fehleranfällig sein. Sie können Ihren Workflow mit einer bevorzugten IDE oder einem Quellcode-Editor erstellen und automatische Vervollständigung und Syntaxvalidierung einrichten, um Fehler zu reduzieren.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Workflows auf.

    Zur Seite "Workflows"

  2. Klicken Sie auf  Erstellen.

  3. Geben Sie einen Namen für den Workflow ein, z. B. myFirstWorkflow. Der Name kann Buchstaben, Zahlen, Unterstriche und Bindestriche enthalten. Muss mit einem Buchstaben beginnen und mit einer Zahl oder einem Buchstaben enden.

  4. Fügen Sie optional eine Beschreibung des Workflows hinzu.

  5. Wählen Sie in der Liste Region einen geeigneten Standort für die Bereitstellung des Workflows aus, z. B. us-central1.

  6. Wählen Sie in der Liste Dienstkonto ein Dienstkonto aus, das Ihr Workflow für den Zugriff auf andere Google Cloud Dienste verwendet. Weitere Informationen finden Sie unter Dienstkonto erstellen.

  7. Führen Sie optional die folgenden Schritte aus:

    1. Geben Sie die Ebene des Aufruf-Logging an, die Sie auf die Workflow-Definition 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 Protokolle: Es werden keine Anrufe protokolliert.

    2. Geben Sie die Ebene des Ausführungsverlaufs an, die Sie auf die Workflow-Definition anwenden möchten. Wählen Sie in der Liste Ausführungsverlauf eine der folgenden Optionen aus:

      • Basic: Aktiviert den einfachen Ausführungsverlauf. Das ist die Standardeinstellung.
      • Detailliert: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.

    3. Geben Sie den Cloud Key Management Service-Schlüssel an, den der Workflow für die Datenverschlüsselung verwenden soll: Wählen Sie Kundenverwalteter Verschlüsselungsschlüssel (CMEK) aus. Weitere Informationen finden Sie unter kundenverwaltete Verschlüsselungsschlüssel verwenden.

    4. Geben Sie eine Umgebungsvariable an, auf die der Workflow zur Laufzeit zugreifen kann. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.

    5. Label hinzufügen: Labels sind Schlüssel/Wert-Paare, mit denen Sie IhreGoogle Cloud -Instanzen organisieren können. Weitere Informationen finden Sie unter Was sind Labels? Workflow-Labels werden von Ausführungen des Workflows übernommen. Verwenden Sie die Methode workflows.executions.list, um Ausführungslabels aufzulisten und zu filtern.

    6. Workflow planen: Wählen Sie Neuen Trigger hinzufügen > Cloud Scheduler aus. Weitere Informationen finden Sie unter Workflow mit Cloud Scheduler planen.

    7. Workflow über ein Ereignis oder eine Pub/Sub-Nachricht auslösen: Wählen Sie Neuen Trigger hinzufügen > Eventarc aus. Weitere Informationen finden Sie unter Workflow mit Ereignissen oder Pub/Sub-Nachrichten auslösen.

  8. Klicken Sie auf Next (Weiter).

  9. Geben Sie im Workflow-Editor die Definition für Ihren Workflow ein. Beispiel-Workflow ansehen

  10. Klicken Sie auf Bereitstellen.

gcloud

  1. Achten Sie darauf, dass der Quellcode Ihres Workflows in einer YAML- oder JSON-Datei gespeichert ist, z. B. MY_WORKFLOW.YAML oder MY_WORKFLOW.JSON. Sehen Sie sich einen Beispielworkflow an.

  2. Öffnen Sie ein Terminalfenster.

  3. Sie können einen Workflow mit dem Befehl gcloud workflows deploy erstellen und bereitstellen:

    gcloud workflows deploy WORKFLOW_NAME \
    --location=LOCATION \
    --call-log-level=CALL_LOGGING_LEVEL \
    --description="DESCRIPTION" \
    --execution-history-level="EXECUTION_HISTORY_LEVEL" \
    --labels="LABEL_KEY=LABEL_VALUE" \
    --set-env-vars="ENV_KEY=ENV_VALUE" \
    --kms-key=ENCRYPT_KEY \
    --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
    --source=YAML_OR_JSON_SOURCE_FILE

    Ersetzen Sie Folgendes:

    • WORKFLOW_NAME: Der Name Ihres Workflows, z. B. myFirstWorkflow. Der Name darf Buchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Sie muss mit einem Buchstaben beginnen und mit einer Ziffer oder einem Buchstaben enden.

    • LOCATION: Die Region, in der Sie Ihren Workflow bereitstellen möchten, z. B. us-central1.

    • CALL_LOGGING_LEVEL: optional. Ebene des Aufruf-Logging, die 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.

    • DESCRIPTION: optional. Eine Beschreibung des Workflows.

    • 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 Ebene für den Ausführungsverlauf angegeben. Das ist die Standardeinstellung. Wenn für eine Ausführung keine Ausführlichkeitsstufe für den Ausführungsverlauf angegeben ist, wird die für den Workflow angewendete Stufe verwendet. 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-detailed: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.

    • LABEL_KEY=LABEL_VALUE: optional. Eine Liste von Schlüssel/Wert-Paaren für Labels, mit denen Sie IhreGoogle Cloud -Instanzen organisieren können, z. B. name=wrench. Weitere Informationen finden Sie unter Was sind Labels? Workflow-Labels werden von Ausführungen des Workflows übernommen. Verwenden Sie die Methode workflows.executions.list, um Ausführungslabels aufzulisten und zu filtern.

    • ENV_KEY=ENV_VALUE: optional. Liste der Schlüssel/Wert-Paare für Umgebungsvariablen, z. B. MONTH=January. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.

    • ENCRYPT_KEY: optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung verwendet werden soll, im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Weitere Informationen finden Sie unter kundenverwaltete Verschlüsselungsschlüssel verwenden.

    • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: Optional. Das Dienstkonto, mit dem Ihr Workflow auf andereGoogle Cloud -Dienste zugreift. Weitere Informationen finden Sie in diesem Dokument unter Dienstkonto erstellen.

    • YAML_OR_JSON_SOURCE_FILE: Die Quelldatei für die Workflowdefinition. Beispiel: myFirstWorkflow.yaml

REST

Verwenden Sie die Methode projects.locations.workflows.create, um einen neuen Workflow mit einem angegebenen Namen zu erstellen, und geben Sie mit dem Abfrageparameter workflowId eine ID für den Workflow an.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • WORKFLOW_NAME: Der Name Ihres Workflows, z. B. myFirstWorkflow. Der Name darf Buchstaben, Zahlen, Unterstriche und Bindestriche enthalten. Er muss mit einem Buchstaben beginnen und mit einer Ziffer oder einem Buchstaben enden.
  • DESCRIPTION: optional. Eine Beschreibung Ihres Workflows. Darf nicht länger als 1.000 Unicode-Zeichen sein.
  • LABEL_KEY und LABEL_VALUE: Optional. Eine Zuordnung von Label-Schlüssel/Wert-Paaren, mit denen Sie Ihre Google Cloud -Instanzen organisieren können. Beispiel: {"name": "wrench", "mass": "1kg", "count": "3"} Weitere Informationen finden Sie unter Was sind Labels? Workflow-Labels werden von Ausführungen des Workflows übernommen. Verwenden Sie die Methode workflows.executions.list, um Ausführungslabels aufzulisten und zu filtern.
  • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: optional. Das Dienstkonto, mit dem Ihr Workflow auf andere Google Cloud Dienste zugreift. Die Projekt-ID ist Ihre Google Cloud Projekt-ID. Weitere Informationen finden Sie in diesem Dokument unter Dienstkonto erstellen.
  • ENCRYPT_KEY: optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung verwendet werden soll, im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Weitere Informationen finden Sie unter kundenverwaltete Verschlüsselungsschlüssel verwenden.
  • CALL_LOGGING_LEVEL: optional. Die Aufruflogebene, 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 wird 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.
  • EXECUTION_HISTORY_LEVEL: Optional. Die Ebene des Ausführungsverlaufs, 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 Ebene für den Ausführungsverlauf angegeben. Das ist die Standardeinstellung. Wenn für eine Ausführung keine Ausführlichkeitsstufe für den Ausführungsverlauf angegeben ist, wird die für den Workflow angewendete Stufe verwendet. 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 grundlegenden Ausführungsverlauf.
    • EXECUTION_HISTORY_ADVANCED: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.
  • ENV_KEY und ENV_VALUE: Optional. Eine Zuordnung von Schlüssel/Wert-Paaren für Umgebungsvariablen, z. B. { "month": "January", "day": "Monday"}. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.
  • SOURCE_CODE: Die Workflowdefinition. Zeilenumbrüche müssen in YAML mit Escape-Zeichen versehen werden. Beispiel: main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello.

    Anführungszeichen müssen in JSON maskiert werden. Beispiel: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}

  • LOCATION: die Region, in der der Workflow bereitgestellt werden soll, z. B. us-central1.

JSON-Text der Anfrage:

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "executionHistoryLevel": "EXECUTION_HISTORY_LEVEL"
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

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

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Operation. 

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "create",
    "apiVersion": "v1"
  },
  "done": false
}

Wenn der Wert von "done" false ist, ist der Vorgang noch aktiv.

Workflows auflisten

Sie können Workflows auflisten oder Filter verwenden, um einen bestimmten Workflow abzurufen.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Workflows auf.

    Zur Seite "Workflows"

    Auf dieser Seite werden Ihre Workflows an allen Standorten aufgelistet. Außerdem enthält sie Details wie Namen, Regionen, letzte Überarbeitungen usw.

  2. So filtern Sie Ihre Workflows:

    1. Klicken Sie auf Filter oder das Feld Workflows filtern.
    2. Wählen Sie in der Liste Attribute eine Option aus, nach der die Workflows gefiltert werden sollen.

    Sie können ein einzelnes Attribut auswählen oder den logischen Operator OR verwenden, um weitere Attribute hinzuzufügen.

  3. Klicken Sie zum Sortieren der Workflows neben einer beliebigen unterstützten Spaltenüberschrift auf  Sortieren.

gcloud

Listen Sie Workflows mit dem Befehl gcloud workflows list auf:

gcloud workflows list --location=LOCATION

Ersetzen Sie LOCATION durch die ID oder die voll qualifizierte Kennzeichnung des Standorts Ihres Workflows.

Mit diesem Befehl werden Ihre Workflows am angegebenen Ort aufgelistet. Er enthält Details wie NAME, STATE, REVISION_ID und UPDATE_TIME eines Workflows.

REST

Verwenden Sie die Methode projects.locations.workflows.list, um Workflows in einem bestimmten Projekt und an einem bestimmten Standort aufzulisten.

Alternativ können Sie die Methode projects.locations.workflows.get verwenden, um die Details eines einzelnen Workflows abzurufen.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Google Cloud Projekt-ID.
  • LOCATION: die Region, in der die Workflows bereitgestellt werden, z. B. us-central1.

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

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Instanzen von Workflow und die Antwort sollte in etwa so aussehen: 

{
  "workflows": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
      "state": "ACTIVE",
      "revisionId": "000001-0ce",
      "createTime": "2023-12-08T13:56:59.306770745Z",
      "updateTime": "2023-12-08T13:56:59.547021939Z",
      "revisionCreateTime": "2023-12-08T13:56:59.340161044Z",
      "serviceAccount": "projects/PROJECT_ID/serviceAccounts/PROJECT_NUMBER-compute@developer.gserviceaccount.com",
      "sourceContents": "main:\n    params: [input]\n [...] return: '${wikiResult.body[1]}'\n"
    },
    {
      object (Workflow)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}

Workflow aktualisieren

Sie können einen vorhandenen Workflow aktualisieren. Sie müssen den Namen des Workflows, den Sie aktualisieren möchten, und seine Quelle angeben. Sie können den Namen oder den Speicherort eines Workflows nicht ändern.

Das Aktualisieren eines Workflows hat keine Auswirkungen auf laufende Ausführungen. Nur zukünftige Ausführungen des Workflows verwenden die aktualisierte Konfiguration.

Jedes Mal, wenn Sie einen Workflow aktualisieren, wird dessen versionID aktualisiert. Der versionID besteht aus zwei Teilen, die durch einen Bindestrich getrennt sind:

  • Eine Zahl, die bei eins beginnt und jedes Mal erhöht wird, wenn Sie einen Workflow aktualisieren.

  • Ein zufälliger, dreistelliger alphanumerischer String.

000001-27f steht beispielsweise für die ursprüngliche Version eines Workflows und 000002-d52 für einen Workflow, der einmal aktualisiert wurde.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Workflows auf.

    Zur Seite "Workflows"

  2. Klicken Sie auf den Namen des Workflows, den Sie aktualisieren möchten. Der Name des Workflows kann nicht geändert werden.

    Die Seite Workflowdetails wird angezeigt.

  3. Sie haben folgende Möglichkeiten, den Workflow zu bearbeiten:

    • So bearbeiten Sie die Quelle:

      1. Klicken Sie auf den Tab Quelle.
      2. Klicken Sie auf Bearbeiten.
      3. Um die Änderungen zu speichern, klicken Sie auf Speichern. Der aktualisierte Workflow wird bereitgestellt.

    • So aktualisieren Sie die Beschreibung, das Dienstkonto, das der Workflow zur Authentifizierung verwendet, die Aufruflogebene, Umgebungsvariablen, Labels oder den Verschlüsselungsschlüssel:

      1. Klicken Sie auf den Tab Details.
      2. Klicken Sie auf das entsprechende Symbol .
      3. Wenn Sie die Anruflogebene aktualisieren, wählen Sie 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 Protokolle: Es werden keine Anrufe protokolliert.
      4. Wenn Sie die Ebene des Ausführungsverlaufs aktualisieren, wählen Sie eine der folgenden Optionen aus:
        • Basic: Aktiviert den einfachen Ausführungsverlauf. Das ist die Standardeinstellung.
        • Detailliert: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.
      5. Wenn Sie ein vorhandenes Label aktualisieren oder ein neues hinzufügen, kann es bis zu 10 Minuten dauern, bis das neue Label wirksam wird. Workflow-Labels werden von Ausführungen des Workflows übernommen. Verwenden Sie die Methode workflows.executions.list, um Ausführungslabels aufzulisten und zu filtern.
      6. Um die Änderungen zu speichern, klicken Sie auf Speichern. Der aktualisierte Workflow wird bereitgestellt.

    • So bearbeiten Sie die vorherigen Felder gleichzeitig oder fügen einen Trigger hinzu oder aktualisieren ihn:

      1. Klicken Sie auf  Bearbeiten.
      2. Klicken Sie auf Weiter, um die Quelle zu bearbeiten.
      3. Klicken Sie auf Bereitstellen, um die Änderungen zu speichern und den aktualisierten Workflow bereitzustellen.

  4. Wenn Sie die Rollen für Ihr Dienstkonto aktualisieren möchten, klicken Sie auf den Tab Berechtigungen.

    1. Hauptkonten sind Nutzer, Gruppen, Domains oder Dienstkonten. So aktualisieren Sie einen vorhandenen Prinzipal:

      1. Suchen Sie eine Zeile mit dem Hauptkonto.
      2. Klicken Sie in dieser Zeile auf  Hauptkonto bearbeiten.
      3. Klicken Sie auf  Weitere Rolle hinzufügen oder auf  Rolle löschen.

    2. Wenn Sie eine Rolle hinzufügen, wählen Sie in der Liste Rolle auswählen eine geeignete Rolle aus.

    3. Wenn Sie eine weitere Rolle hinzufügen möchten, klicken Sie auf Weitere Rolle hinzufügen.

    4. Klicken Sie auf Speichern.

gcloud

  1. Öffnen Sie ein Terminalfenster.

  2. Suchen Sie den Namen des Workflows, den Sie aktualisieren 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. Suchen Sie die YAML- oder JSON-Datei, in der die Workflowquelle gespeichert ist, z. B. WORKFLOW_NAME.YAML oder WORKFLOW_NAME.JSON.

  4. Sie können einen vorhandenen Workflow aktualisieren, um seine Quelle, Beschreibung, Labels, Umgebungsvariablen, den Anruflokalisierungsgrad, den Verschlüsselungsschlüssel oder das zugehörige Dienstkonto mit dem Befehl gcloud workflows deploy zu ändern.

    Sie müssen den Namen des Workflows angeben, den Sie aktualisieren möchten, sowie die Quelle. Die restlichen Flags sind optional. Verwenden Sie das Flag --clear-kms-key, um einen kundenverwalteten Verschlüsselungsschlüssel zu entfernen.

    gcloud workflows deploy WORKFLOW_NAME \
    --call-log-level=CALL_LOGGING_LEVEL \
    --description="DESCRIPTION" \
    --execution-history-level="EXECUTION_HISTORY_LEVEL" \
    --labels="LABEL_KEY=LABEL_VALUE" \
    --set-env-vars="ENV_KEY=ENV_VALUE" \
    --kms-key=ENCRYPT_KEY \
    --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
    --source=YAML_OR_JSON_SOURCE_FILE

    Ersetzen Sie Folgendes:

    • WORKFLOW_NAME: Erforderlich. Der Name Ihres Workflows.

    • CALL_LOGGING_LEVEL: optional. Ebene des Aufruf-Logging, die 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.

    • DESCRIPTION: optional. Eine Beschreibung des Workflows.

    • 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 Ebene für den Ausführungsverlauf angegeben. Das ist die Standardeinstellung. Wenn für eine Ausführung keine Ausführlichkeitsstufe für den Ausführungsverlauf angegeben ist, wird die für den Workflow angewendete Stufe verwendet. 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-detailed: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.

    • LABEL_KEY=LABEL_VALUE: optional. Eine Liste von Schlüssel/Wert-Paaren für Labels, mit denen Sie IhreGoogle Cloud -Instanzen organisieren können, z. B. name=wrench. Weitere Informationen finden Sie unter Was sind Labels? Workflow-Labels werden von Ausführungen des Workflows übernommen. Verwenden Sie die Methode workflows.executions.list, um Ausführungslabels aufzulisten und zu filtern.

    • ENV_KEY=ENV_VALUE: optional. Liste der Schlüssel/Wert-Paare für Umgebungsvariablen, z. B. MONTH=January. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.

    • ENCRYPT_KEY: optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung verwendet werden soll, im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Weitere Informationen finden Sie unter kundenverwaltete Verschlüsselungsschlüssel verwenden.

    • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: Optional. Das Dienstkonto, mit dem Ihr Workflow auf andereGoogle Cloud -Dienste zugreift. Wenn Sie die Rollen für Ihr Dienstkonto aktualisieren möchten, lesen Sie die Informationen unter Workflow-Berechtigung für den Zugriff auf Google Cloud -Ressourcen erteilen und Zugriff auf Projekte, Ordner und Organisationen verwalten.

    • YAML_OR_JSON_SOURCE_FILE: Erforderlich. Die Quelldatei für den Workflow im YAML- oder JSON-Format. Beispiel: myFirstWorkflow.yaml.

REST

Verwenden Sie zum Aktualisieren eines vorhandenen Workflows die Methode projects.locations.workflows.patch und optional den Abfrageparameter updateMask, um eine Liste der zu aktualisierenden Felder anzugeben.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • WORKFLOW_NAME: Der Name Ihres Workflows, z. B. myFirstWorkflow.
  • DESCRIPTION: optional. Eine Beschreibung Ihres Workflows. Darf nicht länger als 1.000 Unicode-Zeichen sein.
  • LABEL_KEY und LABEL_VALUE: Optional. Eine Zuordnung von Label-Schlüssel/Wert-Paaren, mit denen Sie Ihre Google Cloud -Instanzen organisieren können. Beispiel: {"name": "wrench", "mass": "1kg", "count": "3"} Weitere Informationen finden Sie unter Was sind Labels? Workflow-Labels werden von Ausführungen des Workflows übernommen. Verwenden Sie die Methode workflows.executions.list, um Ausführungslabels aufzulisten und zu filtern.
  • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: optional. Das Dienstkonto, mit dem Ihr Workflow auf andere Google Cloud Dienste zugreift. Die Projekt-ID ist Ihre Google Cloud Projekt-ID. Weitere Informationen finden Sie in diesem Dokument unter Dienstkonto erstellen.
  • ENCRYPT_KEY: optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung verwendet werden soll, im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. Weitere Informationen finden Sie unter kundenverwaltete Verschlüsselungsschlüssel verwenden.
  • CALL_LOGGING_LEVEL: optional. Die Aufruflogebene, 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 wird 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.
  • EXECUTION_HISTORY_LEVEL: Optional. Die Ebene des Ausführungsverlaufs, die während der Ausführung angewendet werden soll. Weitere Informationen finden Sie unter Aufrufverlauf der Ausführungsschritte. 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ührlichkeitsstufe für den Ausführungsverlauf angegeben ist, wird die für den Workflow angewendete Stufe verwendet. 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 grundlegenden Ausführungsverlauf.
    • EXECUTION_HISTORY_ADVANCED: Aktivieren Sie den detaillierten Ausführungsverlauf, einschließlich aller relevanten Variablenwerte und der erwarteten Anzahl von Iterationen.
  • ENV_KEY und ENV_VALUE: Optional. Eine Zuordnung von Schlüssel/Wert-Paaren für Umgebungsvariablen, z. B. { "month": "January", "day": "Monday"}. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.
  • SOURCE_CODE: Die minimierte Workflowdefinition. Beispiel: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}.
  • LOCATION: die Region, in der der Workflow bereitgestellt wird, z. B. us-central1.
  • UPDATE_FIELDS: optional. Eine durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen. Falls nicht angegeben, wird der gesamte Workflow aktualisiert. Beispiel: description,callLogLevel.

JSON-Text der Anfrage:

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "executionHistoryLevel": "EXECUTION_HISTORY_LEVEL"
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

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

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Operation. 

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "update",
    "apiVersion": "v1"
  },
  "done": false
}

Wenn der Wert von "done" false ist, ist der Vorgang noch aktiv.

Workflow löschen

Sie können einen vorhandenen Workflow löschen. Wenn Sie einen Workflow löschen, werden auch seine Ausführungen gelöscht und alle aktiven Ausführungen für den Workflow werden abgebrochen.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Workflows auf.

    Zur Seite "Workflows"

  2. Klicken Sie auf den Namen des Workflows, den Sie löschen möchten, und dann auf  Löschen.

  3. Geben Sie an der Eingabeaufforderung zur Bestätigung des Löschvorgangs den Namen des Workflows ein.

  4. Klicken Sie auf Bestätigen.

gcloud

  1. Öffnen Sie ein Terminalfenster.

  2. Suchen Sie den Namen des Workflows, den Sie löschen 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. Löschen Sie einen Workflow mit dem Befehl gcloud workflows delete:

    gcloud workflows delete WORKFLOW_NAME

    Ersetzen Sie WORKFLOW_NAME durch den Namen Ihres Workflows.

REST

Wenn Sie einen Workflow mit einem bestimmten Namen löschen möchten, verwenden Sie die Methode projects.locations.workflows.delete.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • WORKFLOW_NAME: Der Name des Workflows, den Sie löschen möchten.
  • PROJECT_ID: Ihre Google Cloud Projekt-ID.
  • LOCATION: die Region, in der der Workflow bereitgestellt wird, z. B. us-central1.

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

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation: 

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "delete",
    "apiVersion": "v1"
  },
  "done": false
}

Wenn der Wert von "done" false ist, ist der Vorgang noch aktiv.

Nächste Schritte