此页面由 Cloud Translation API 翻译。

创建和管理工作流

您可以在 Google Cloud 控制台中创建和管理工作流，也可以在终端或 Cloud Shell 中使用 Google Cloud CLI 来创建和管理工作流。您还可以通过 Workflows API 管理工作流。

准备工作

您的组织定义的安全限制条件可能会导致您无法完成以下步骤。如需了解相关问题排查信息，请参阅在受限的 Google Cloud 环境中开发应用。

控制台

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.

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

Go to project selector

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

Enable the Workflows API.

Enable the API

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

Go to project selector

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

Enable the Workflows API.

Enable the API

gcloud

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

Create a Google Cloud project:
```
gcloud projects create PROJECT_ID
```
Replace PROJECT_ID with a name for the Google Cloud project you are creating.
Select the Google Cloud project that you created:
```
gcloud config set project PROJECT_ID
```
Replace PROJECT_ID with your Google Cloud project name.

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

Enable the Workflows API:

gcloud services enable workflows.googleapis.com

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

Create a Google Cloud project:
```
gcloud projects create PROJECT_ID
```
Replace PROJECT_ID with a name for the Google Cloud project you are creating.
Select the Google Cloud project that you created:
```
gcloud config set project PROJECT_ID
```
Replace PROJECT_ID with your Google Cloud project name.

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

Enable the Workflows API:

gcloud services enable workflows.googleapis.com

REST

如需使用 Workflows API 管理工作流，我们建议您使用 Google 提供的客户端库调用 workflows.googleapis.com 服务。如需了解详情，请参阅 Workflows API。

创建服务账号

服务账号代表工作流的身份，并决定工作流拥有哪些权限以及可以访问哪些 Google Cloud 资源。如果您还没有服务账号，请创建一个服务账号，然后为其授予管理工作流和创建日志所需的角色。

如果您在工作流创建期间未指定服务账号，则工作流将使用默认的 Compute Engine 服务账号作为其身份。如需了解详情，请参阅向工作流授予访问 Google Cloud 资源的权限。

我们强烈建议您使用具备访问必需资源所需的最低权限的服务账号。

请注意，如需创建资源并附加服务账号，您需要具备创建该资源的权限以及模拟您将附加到该资源的服务账号的权限。如需了解详情，请参阅服务账号权限。

控制台

在 Google Cloud 控制台中，转到服务账号页面。

转到“服务账号”
选择项目，然后点击创建服务账号。
在服务账号名称字段中，输入一个名称。

此名称必须介于 6 到 30 个字符之间，且可以包含小写字母数字字符和短划线。在服务账号创建完毕后，无法再更改其名称。
点击创建并继续。
点击选择角色
选择以下角色，根据需要点击添加其他角色：
1. 如需创建、更新和执行工作流，请依次选择 Workflows > Workflows Editor。
2. 如需将日志发送到 Cloud Logging，请依次选择 Logging > Logs Writer。
重要提示：对于生产环境，Google 强烈建议您创建新的服务账号，并为其授予一个或多个 IAM 角色，这些角色包含管理工作流所需的最小权限。如需详细了解 Workflows 中可用的权限和角色，请参阅访问权限控制。
点击完成以完成服务账号的创建过程。

gcloud

创建服务账号。

gcloud iam service-accounts create SERVICE_ACCOUNT

通过分配角色向服务账号授予权限。
1. 如需创建、更新和执行工作流，请分配 roles/workflows.editor 角色：
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/workflows.editor"
```
2. 如需将日志发送到 Cloud Logging，请分配 roles/logging.logWriter 角色：
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/logging.logWriter"
```
替换以下内容：
- SERVICE_ACCOUNT：服务账号的名称。该名称必须介于 6 到 30 个字符之间，且可以包含小写字母数字字符和短划线。在服务账号创建完毕后，无法再更改其名称。
- PROJECT_ID：您的项目 ID。
重要提示：对于生产环境，Google 强烈建议您创建新的服务账号，并为其授予一个或多个 IAM 角色，这些角色包含管理工作流所需的最小权限。如需详细了解 Workflows 中可用的权限和角色，请参阅访问权限控制。

REST

您可以使用 serviceAccounts.create 方法创建服务账号。如需了解详情，请参阅创建服务账号。

您可以使用 setIamPolicy 方法修改和设置资源的允许政策，以编程方式授予多个角色。如需了解详情，请参阅以编程方式授予或撤消多个角色。

创建工作流

工作流定义由一系列使用 Workflows 语法描述的步骤组成，该语法可以采用 YAML 或 JSON 格式编写。定义工作流后，可以进行部署，使其可以执行。部署步骤还会验证源文件是否可以执行。如果源文件不包含有效的工作流定义，则会失败。

修改 YAML 文件容易出错。如需创建工作流，您可以使用首选的 IDE 或源代码编辑器，并设置自动补全和语法验证来减少错误。

控制台

在 Google Cloud 控制台中，进入 Workflows 页面：

进入 Workflows
点击创建。
输入工作流的名称，例如 myFirstWorkflow。名称可以包含字母、数字、下划线和连字符。必须以字母开头，并以数字或字母结尾。
（可选）添加工作流的说明。
在区域列表中，选择要部署工作流的适当位置；例如 us-central1。
在服务账号列表中，选择您的工作流将用于访问其他 Google Cloud 服务的服务账号。如需了解详情，请参阅本文档中的创建服务账号部分。
视需要执行下列任一操作：
1. 指定要应用于工作流定义的调用日志记录级别。在调用日志级别列表中，选择以下选项之一：
  - 未指定：未指定日志记录级别。这是默认设置。除非未指定执行日志级别（默认），否则执行日志级别优先于任何工作流日志级别；在这种情况下，工作流日志级别适用。
  - 仅限错误：记录所有已捕获的异常；或者调用因异常而停止时。
  - 所有调用：记录对子工作流或库函数及其结果的所有调用。
  - 无日志：无调用日志记录。
2. 指定工作流应该用于数据加密的 Cloud Key Management Service 密钥：选择客户管理的加密密钥 (CMEK)。如需了解详情，请参阅使用客户管理的加密密钥 (CMEK)。
3. 指定可供工作流在运行时访问的环境变量。如需了解详情，请参阅使用环境变量。
4. 添加标签：标签是可帮助您整理 Google Cloud 实例的键值对。如需了解详情，请参阅什么是标签？工作流标签会被工作流的执行继承。如需查看执行标签，请使用 workflows.executions.list 方法列出和过滤工作流执行。
  
  注意：新标签最多可能需要 10 分钟才能生效。
5. 安排工作流：选择添加新触发器 > Cloud Scheduler。如需了解详情，请参阅使用 Cloud Scheduler 安排工作流。
6. 通过事件或 Pub/Sub 消息触发工作流：选择添加新触发器 > Eventarc。如需了解详情，请参阅使用事件或 Pub/Sub 消息触发工作流。
点击下一步。
在工作流编辑器中，输入工作流的定义。请参阅示例工作流。
点击部署。

gcloud

确保工作流的源代码保存在 YAML 或 JSON 文件中，例如 MY_WORKFLOW.YAML 或 MY_WORKFLOW.JSON。请参阅示例工作流。
打开终端。
您可以使用 gcloud workflows deploy 命令创建和部署工作流：
```
gcloud workflows deploy WORKFLOW_NAME \
    --location=LOCATION \
    --call-log-level=CALL_LOGGING_LEVEL \
    --description="DESCRIPTION" \
    --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
```
替换以下内容：
- WORKFLOW_NAME：工作流的名称，例如 myFirstWorkflow。名称可以包含字母、数字、下划线和连字符。并且必须以字母开头，以数字或字母结尾。
- LOCATION：要在其中部署工作流的区域，例如 us-central1。
- CALL_LOGGING_LEVEL：可选。在执行期间应用的调用日志记录级别。可以是以下之一：
  - none：未指定日志记录级别。这是默认设置。除非未指定执行日志级别（默认），否则执行日志级别优先于任何工作流日志级别；在这种情况下，工作流日志级别适用。
  - log-errors-only：记录所有已捕获的异常；或者调用因异常而停止时。
  - log-all-calls：记录对子工作流或库函数及其调用的所有调用。
  - log-none：无调用日志记录。
- DESCRIPTION：可选。工作流程说明。
- LABEL_KEY=LABEL_VALUE：可选。标签键值对列表，可帮助您整理 Google Cloud 实例；例如 name=wrench。如需了解详情，请参阅什么是标签？工作流标签会被工作流的执行继承。如需查看执行标签，请使用 workflows.executions.list 方法列出和过滤工作流执行。
  
  注意：新标签最多可能需要 10 分钟才能生效。
- ENV_KEY=ENV_VALUE：可选。环境变量键值对的列表；例如 MONTH=January。如需了解详情，请参阅使用环境变量。
- ENCRYPT_KEY：可选。工作流用于数据加密的 Cloud KMS 密钥，格式为 projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME。如需了解详情，请参阅使用客户管理的加密密钥 (CMEK)。
- SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com：可选。您的工作流将用于访问其他 Google Cloud 服务的服务账号。如需了解详情，请参阅本文档中的创建服务账号部分。
- YAML_OR_JSON_SOURCE_FILE：工作流定义的源文件。例如：myFirstWorkflow.yaml。

REST

如需创建具有指定名称的新工作流，请使用 projects.locations.workflows.create 方法，并使用 workflowId 查询参数为工作流指定 ID。

在使用任何请求数据之前，请先进行以下替换：

WORKFLOW_NAME：工作流的名称，例如 myFirstWorkflow。名称可以包含字母、数字、下划线和连字符。并且必须以字母开头，以数字或字母结尾。
DESCRIPTION：可选。工作流的说明。不得超过 1000 个 Unicode 字符。
LABEL_KEY 和 LABEL_VALUE：可选。标签键值对的映射，可帮助您整理 Google Cloud 实例。例如：{"name": "wrench", "mass": "1kg", "count": "3"} 如需了解详情，请参阅什么是标签？工作流标签会被工作流的执行继承。如需查看执行标签，请使用 workflows.executions.list 方法列出和过滤工作流执行。
注意：新标签最多可能需要 10 分钟才能生效。

SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com：可选。您的工作流将用于访问其他 Google Cloud 服务的服务账号。项目 ID 是您的 Google Cloud 项目 ID。如需了解详情，请参阅本文档中的创建服务账号部分。
ENCRYPT_KEY：可选。工作流用于数据加密的 Cloud KMS 密钥，格式为 projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME。如需了解详情，请参阅使用客户管理的加密密钥。
CALL_LOGGING_LEVEL：可选。在执行期间应用的调用日志记录级别。默认情况下，系统不会指定日志记录级别，而是会应用工作流日志级别。如需了解详情，请参阅将日志发送到 Logging。以下各项之一：
- CALL_LOG_LEVEL_UNSPECIFIED：未指定日志记录级别，系统会改为应用工作流日志级别。这是默认设置。否则，系统会应用执行日志级别，该级别的优先级高于工作流日志级别。
- LOG_ERRORS_ONLY：记录所有已捕获的异常；或者调用因异常而停止时。
- LOG_ALL_CALLS：记录对子工作流或库函数及其结果的所有调用。
- LOG_NONE：无调用日志记录。
ENV_KEY 和 ENV_VALUE：可选。环境变量键值对的映射；例如 { "month": "January", "day": "Monday"}。如需了解详情，请参阅使用环境变量。
SOURCE_CODE：工作流定义。您必须转义 YAML 中的换行符。例如：main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello
您必须对 JSON 中的引号进行转义。例如：{\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}
LOCATION：要部署此工作流的区域，例如 us-central1。

请求 JSON 正文：

{
  "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",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

cat > request.json << 'EOF'
{
  "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",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
EOF

然后，执行以下命令以发送 REST 请求：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows?workflowId=WORKFLOW_NAME"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

@'
{
  "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",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
'@  | Out-File -FilePath request.json -Encoding utf8

然后，执行以下命令以发送 REST 请求：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows?workflowId=WORKFLOW_NAME" | Select-Object -Expand Content

APIs Explorer（浏览器）

复制请求正文并打开方法参考页面。APIs Explorer 面板会在页面右侧打开。您可以与此工具进行交互以发送请求。将请求正文粘贴到此工具中，填写任何其他必填字段，然后点击执行。

如果成功，响应正文将包含一个新创建的 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
}

如果 "done" 的值为 false，则表示操作仍在进行中。

列出工作流

您可以列出工作流，也可以使用过滤条件检索特定工作流。

控制台

在 Google Cloud 控制台中，前往工作流页面。

进入 Workflows

此页面会列出所有位置的工作流，并包含名称、区域、最新修订版本等详细信息。
如需过滤工作流，请执行以下操作：
1. 点击过滤或过滤工作流字段。
2. 在属性列表中，选择要作为工作流过滤条件的选项。
您可以选择单个属性，或使用逻辑运算符 OR 添加更多属性。
如需对工作流进行排序，请点击任意受支持的列标题旁边的排序。

gcloud

使用 gcloud workflows list 命令列出工作流：

gcloud workflows list --location=LOCATION

将 LOCATION 替换为工作流位置的 ID 或完全限定标识符。

此命令会列出指定位置中的工作流，并包含工作流的 NAME、STATE、REVISION_ID 和 UPDATE_TIME 等详细信息。

REST

如需列出指定项目和位置中的工作流，请使用 projects.locations.workflows.list 方法。

或者，如需检索单个工作流的详细信息，请使用 projects.locations.workflows.get 方法。

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：您的 Google Cloud 项目 ID。
LOCATION：在其中部署此工作流的区域，例如 us-central1。

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

执行以下命令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows" | Select-Object -Expand Content

APIs Explorer（浏览器）

打开方法参考页面。APIs Explorer 面板会在页面右侧打开。您可以与此工具进行交互以发送请求。填写所有必填字段，然后点击执行。

如果成功，则响应正文包含 Workflow 的实例，并且响应应类似如下内容：

{
  "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
  ]
}

更新工作流

您可以更新现有工作流。您必须指定要更新的工作流的名称及其来源。请注意，您无法更改工作流的名称或位置。

更新工作流不会影响正在进行的执行。只有工作流的未来执行才会使用更新后的配置。

每次更新工作流时，系统都会更新其 versionID。versionID 由两部分组成，并以连字符隔开：

这是每次更新工作流时都会递增的数字，从 1 开始。
由三个字符组成的随机字母数字字符串。

例如，000001-27f 表示工作流的初始版本，000002-d52 表示已更新一次的工作流。

控制台

在 Google Cloud 控制台中，前往工作流页面。

进入 Workflows
点击您要更新的工作流的名称。请注意，您无法更改工作流的名称。

系统随即会显示工作流详情页面。
您可以通过以下方式修改工作流：
- 如需修改来源，请执行以下操作：
  1. 点击来源标签页。
  2. 点击修改。
  3. 要保存更改，请点击保存。更新的工作流已部署。
- 如需更新说明、工作流用于身份验证的服务账号、通话记录级别、环境变量、标签或加密密钥，请执行以下操作：
  1. 点击详情标签页。
  2. 点击相应的图标。
  3. 如果您要更新通话记录级别，请选择以下选项之一：
    - 未指定：未指定日志记录级别。这是默认设置。除非未指定执行日志级别（默认），否则执行日志级别优先于任何工作流日志级别；在这种情况下，工作流日志级别适用。
    - 仅限错误：记录所有已捕获的异常；或者调用因异常而停止时。
    - 所有调用：记录对子工作流或库函数及其结果的所有调用。
    - 无日志：无调用日志记录。
  4. 如果您更新现有标签或添加新标签，则新标签最多可能需要 10 分钟才能生效。工作流标签会被工作流的执行继承。如需查看执行标签，请使用 workflows.executions.list 方法列出和过滤工作流执行。
  5. 要保存更改，请点击保存。更新的工作流已部署。
- 如需同时修改之前的字段，或添加或更新触发器，请执行以下操作：
  1. 点击修改。
  2. 如需修改来源，请点击下一步。
  3. 如需保存更改并部署更新后的工作流，请点击部署。
如果您想更新服务账号的角色，请点击权限标签页。
1. 主账号是用户、群组、网域或服务账号。如需更新现有主账号，请执行以下操作：
  1. 找到包含主账号的行。
  2. 点击该行中的 修改主账号。
  3. 点击 添加其他角色或点击 删除角色。
2. 如果您要添加角色，请在选择角色列表中选择适当的角色。
3. 如需添加其他角色，请点击添加其他角色。
4. 点击保存。
注意：如需更改工作流用于身份验证的服务账号，您仍然必须按照上一步中详述的方式修改工作流并修改服务账号。如需了解详情，请参阅向工作流授予访问 Google Cloud 资源的权限。

gcloud

打开终端。
找到您要更新的工作流的名称。如果您不知道工作流的名称，则可以输入以下命令列出所有工作流：
```
gcloud workflows list
```
找到工作流来源保存到的 YAML 或 JSON 文件，例如 WORKFLOW_NAME.YAML 或 WORKFLOW_NAME.JSON。
您可以使用 gcloud workflows deploy 命令更新现有工作流，以更改其来源、说明、标签、环境变量、通话记录级别、加密密钥或其关联的服务账号。

您必须指定要更新的工作流的名称及其来源；但其他标志是可选的。如需移除客户管理的加密密钥，请使用 --clear-kms-key 标志。
```
gcloud workflows deploy WORKFLOW_NAME \
    --call-log-level=CALL_LOGGING_LEVEL \
    --description="DESCRIPTION" \
    --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
```
替换以下内容：
- WORKFLOW_NAME：必填。工作流的名称。
- CALL_LOGGING_LEVEL：可选。要应用于工作流的调用日志记录级别。可以是以下之一：
  - none：未指定日志记录级别。这是默认设置。除非未指定执行日志级别（默认），否则执行日志级别优先于任何工作流日志级别；在这种情况下，工作流日志级别适用。
  - log-errors-only：记录所有已捕获的异常；或者调用因异常而停止时。
  - log-all-calls：记录对子工作流或库函数及其调用的所有调用。
  - log-none：无调用日志记录。
- DESCRIPTION：可选。工作流程说明。
- LABEL_KEY=LABEL_VALUE：可选。标签键值对列表，可帮助您整理 Google Cloud 实例；例如 name=wrench。如需了解详情，请参阅什么是标签？工作流标签会被工作流的执行继承。如需查看执行标签，请使用 workflows.executions.list 方法列出和过滤工作流执行。
  
  注意：如果您更新现有标签或添加新标签，则新标签最多可能需要 10 分钟才能生效。
- ENV_KEY=ENV_VALUE：可选。环境变量键值对的列表；例如 MONTH=January。如需了解详情，请参阅使用环境变量。
- ENCRYPT_KEY：可选。工作流用于数据加密的 Cloud KMS 密钥，格式为 projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME。如需了解详情，请参阅使用客户管理的加密密钥 (CMEK)。
- SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com：可选。您的工作流将用于访问其他 Google Cloud 服务的服务账号。如果您想更新服务账号的角色，请参阅向工作流授予访问 Google Cloud 资源的权限和管理对项目、文件夹和组织的访问权限。
- YAML_OR_JSON_SOURCE_FILE：必填。工作流的源文件，采用 YAML 或 JSON 格式。例如：myFirstWorkflow.yaml。

REST

如需更新现有工作流，请使用 projects.locations.workflows.patch 方法，并视情况使用 updateMask 查询参数指定要更新的字段列表。

在使用任何请求数据之前，请先进行以下替换：

WORKFLOW_NAME：工作流的名称，例如 myFirstWorkflow。
DESCRIPTION：可选。工作流的说明。不得超过 1,000 个 Unicode 字符。
LABEL_KEY 和 LABEL_VALUE：可选。标签键值对的映射，可帮助您整理 Google Cloud 实例。例如：{"name": "wrench", "mass": "1kg", "count": "3"} 如需了解详情，请参阅什么是标签？工作流标签会被工作流的执行继承。如需查看执行标签，请使用 workflows.executions.list 方法列出和过滤工作流执行。
注意：如果您更新现有标签或添加新标签，则新标签最多可能需要 10 分钟才能生效。

SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com：可选。您的工作流将用于访问其他 Google Cloud 服务的服务账号。项目 ID 是您的 Google Cloud 项目 ID。如需了解详情，请参阅本文档中的创建服务账号部分。
ENCRYPT_KEY：可选。工作流用于数据加密的 Cloud KMS 密钥，格式为 projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME。如需了解详情，请参阅使用客户管理的加密密钥。
CALL_LOGGING_LEVEL：可选。在执行期间应用的调用日志记录级别。默认情况下，系统不会指定日志记录级别，而是会应用工作流日志级别。如需了解详情，请参阅将日志发送到 Logging。以下各项之一：
- CALL_LOG_LEVEL_UNSPECIFIED：未指定日志记录级别，系统会改为应用工作流日志级别。这是默认设置。否则，系统会应用执行日志级别，该级别的优先级高于工作流日志级别。
- LOG_ERRORS_ONLY：记录所有已捕获的异常；或者调用因异常而停止时。
- LOG_ALL_CALLS：记录对子工作流或库函数及其结果的所有调用。
- LOG_NONE：无调用日志记录。
ENV_KEY 和 ENV_VALUE：可选。环境变量键值对的映射；例如 { "month": "January", "day": "Monday"}。如需了解详情，请参阅使用环境变量。
SOURCE_CODE：经过缩减的工作流定义。例如：{\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}
LOCATION：在其中部署此工作流的区域，例如 us-central1。
UPDATE_FIELDS：可选。要更新的字段的逗号分隔列表。如果未提供，则更新整个工作流。例如 description,callLogLevel。

请求 JSON 正文：

{
  "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",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

cat > request.json << 'EOF'
{
  "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",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
EOF

然后，执行以下命令以发送 REST 请求：

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME?updateMask="UPDATE_FIELDS""

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

@'
{
  "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",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}
'@  | Out-File -FilePath request.json -Encoding utf8

然后，执行以下命令以发送 REST 请求：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME?updateMask="UPDATE_FIELDS"" | Select-Object -Expand Content

APIs Explorer（浏览器）

如果成功，响应正文将包含一个新创建的 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
}

如果 "done" 的值为 false，则表示操作仍在进行中。

删除工作流

您可以删除现有工作流。删除工作流时，系统也会删除其执行作业，并取消该工作流的所有正在执行的作业。

控制台

在 Google Cloud 控制台中，前往工作流页面。

进入 Workflows
点击要删除的工作流的名称，然后点击删除。
在系统提示确认删除时，输入工作流名称。
点击确认。

gcloud

打开终端。
找到您要删除的工作流的名称。如果您不知道工作流的名称，则可以输入以下命令列出所有工作流：
```
gcloud workflows list
```
使用 gcloud workflows delete 命令删除工作流：
```
gcloud workflows delete WORKFLOW_NAME
```
将 WORKFLOW_NAME 替换为您的工作流名称。

REST

如需删除具有指定名称的工作流，请使用 projects.locations.workflows.delete 方法。

在使用任何请求数据之前，请先进行以下替换：

WORKFLOW_NAME：要删除的工作流的名称。
PROJECT_ID：您的 Google Cloud 项目 ID。
LOCATION：在其中部署此工作流的区域，例如 us-central1。

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

执行以下命令：

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://workflows.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME" | Select-Object -Expand Content

APIs Explorer（浏览器）

打开方法参考页面。APIs Explorer 面板会在页面右侧打开。您可以与此工具进行交互以发送请求。填写所有必填字段，然后点击执行。

如果成功，则响应正文包含一个 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
}

如果 "done" 的值为 false，则表示操作仍在进行中。

创建和管理工作流

准备工作

控制台

gcloud

REST

创建服务账号

控制台

gcloud

REST

创建工作流

控制台

gcloud

REST

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

APIs Explorer（浏览器）

列出工作流

控制台

gcloud

REST

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

APIs Explorer（浏览器）

更新工作流

控制台

gcloud

REST

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

APIs Explorer（浏览器）

删除工作流

控制台

gcloud

REST

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

APIs Explorer（浏览器）

后续步骤