您可以检索指定工作流执行的历史记录，以 step 条目列表的形式返回。每个步骤条目都提供可帮助您分析、调试或优化工作流的信息。例如，您可以确认实际执行了哪些步骤，还可以确定某个步骤的持续时间和成功情况。 在调试大型或复杂的非线性工作流（例如，具有许多并行分支的工作流）时，这会特别有用。
步条目表示源代码中的实际步（例如 assign 或 call）或指令块（例如 for 循环或 try/retry/except 块）。如需查看步数的完整列表，请参阅 StepType。
执行历史记录级别
创建或执行工作流时，您可以指定基本或详细执行历史记录。您可以在工作流级层或执行级层应用此设置。
默认情况下，未指定执行历史记录级别，系统会返回基本步骤条目。
如果您希望执行历史记录包含任何有效范围内的变量值，以及（如果适用）预期的迭代次数（例如，在使用 for 循环或并行分支或迭代时），则必须将执行历史记录级别设置为 Detailed。
如果未为执行指定执行历史记录级别，则该级别由应用于工作流的级别决定。如果级别不同，则在执行级别应用的设置会替换在工作流级别应用的设置。
如何检索步数条目
您可以通过以下方式检索步骤条目：向 Workflow Executions REST API 发送请求，或通过 Google Cloud 控制台检索：
Google Cloud 控制台 - 在本文档中，请参阅在控制台中查看步数条目。
除了列出步骤条目及其详细信息之外，控制台还提供执行步骤的图形表示，让您可以更轻松地查看和分析工作流执行路径。
步数输入信息
步数条目包含以下信息。详细的步数条目还包含基本的步数条目信息。
如需了解详情，请参阅本文档中的示例。
基本步数条目信息
| 名称 | 步入点的完整资源名称，这是一个具有以下格式的唯一 ID，其中 STEPENTRY_ID 是递增的计数器：
|
| 创建和更新时间 | 相应步数条目的创建时间和最近一次更新的时间戳。如果某个步骤条目已完成，updateTime 会指明完成时间。
|
| 日常安排和步骤名称 | 相应步数条目所属的例程和步数的名称。例程名称是在 YAML 或 JSON 源代码中定义的子工作流名称。顶级例程名称为 main。
|
| 状态和进度类型 | 步进条目的状态，例如条目是成功还是失败，或者步进条目是否正在进行以及进度类型。如需查看状态和进度类型的完整列表，请参阅状态和 ProgressType。 |
| 导航信息 | 步骤条目的位置，以便您更好地了解工作流的层次结构和流程 - 例如，哪些步骤条目位于当前步骤条目之前或之后，或者哪些是步骤条目的父条目或子条目。 如需了解详情，请参阅 NavigationInfo。 |
| 元数据 | 与迭代步骤条目相关的数据，可能包括以下内容：
|
| 例外情况 | 与任何异常相关的载荷，并提供有关步数条目为何失败的说明。 |
详细的步数输入信息
| 元数据 | 如果适用，相应步骤进度中的预期迭代次数，例如在使用 请注意，如果循环边界包含以下任一表达式，则计算出的数量将无法按预期运行：
|
| 可变数据 | 与此步骤关联的有效范围内变量值相关的数据，包括用户定义的局部变量的名称和值，以及表达式求值的结果。 请注意，该范围不包括与 Workflows 内置函数关联的内部变量。 如需了解详情，请参阅 VariableData。 |
在控制台中查看步数条目
您可以在Google Cloud 控制台中查看特定工作流执行的步骤条目。
在 Google Cloud 控制台中，前往 Workflows 页面。
点击工作流的名称以转到其工作流详情页面。
如需详细了解特定执行，请点击其执行 ID。
摘要标签页会提供有关整体执行的信息，包括导致执行失败的任何异常。如需了解详情，请参阅执行错误映射。
如需将工作流执行历史记录显示为步骤条目列表，请点击步骤标签页。
系统会列出工作流执行的所有步骤条目。
如需过滤步数条目，请使用表格顶部的过滤条件字段选择属性和值，例如
State: Failed。如需显示任何父、子、下一步和上一步条目的链接，请点击特定步骤条目。
如果您点击某个链接，其他链接会自动更新。例如，父级会链接到您点击的步骤条目的父级。
可视化图表面板以图形方式显示工作流中的步骤，有助于您了解工作流路径。
可视化面板示例
点击图表可将其放大：
请注意，可视化图表可能与步数条目不同。例如，
for块在可视化图表中显示为单个组件；不过，根据迭代次数，可能会有多个步骤条目。您可以在该面板中执行以下操作：
- 放大或缩小可视化图表
- 收起或展开父级步骤条目
- 点击某个步数条目，查看其前一个和后一个条目
- 确认成功和失败的步骤条目（以绿色对勾标记或红色感叹号表示）
- 点击展开箭头关闭可视化图表面板；再次点击该箭头可打开该面板
检索步数条目之前
如需获得检索步骤条目所需的权限，请让您的管理员为您授予项目的 Workflows Admin (workflows.stepEntries.get) IAM 角色。
如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。
检索步数条目
如需检索给定工作流执行的步骤条目，请使用 projects.locations.workflows.executions.stepEntries.get 方法。
在使用任何请求数据之前，请先进行以下替换：
PROJECT_NUMBER：IAM 和管理设置页面中列出的 Google Cloud项目编号。LOCATION：在其中部署工作流的区域，例如us-central1。WORKFLOW_ID：工作流的用户定义名称，例如myFirstWorkflow。EXECUTION_ID：工作流执行的唯一 ID，在工作流执行后返回。STEPENTRY_ID：步数条目的唯一 ID，例如1。
如需发送您的请求，请展开以下选项之一：
您应该收到类似以下内容的 JSON 响应：
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/STEPENTRY_ID",
"createTime": "2024-08-15T19:03:08.328851864Z",
"updateTime": "2024-08-15T19:03:08.331099634Z",
"routine": "main",
"step": "checkSearchTermInInput",
"stepType": "STEP_CONDITION",
"state": "STATE_SUCCEEDED",
"entryId": "2",
"navigationInfo": {
"children": [
"3"
],
"parent": "1",
"next": "3",
"previous": "1"
},
"variableData": {}
}
列出步数条目之前
如需获得列出步骤条目所需的权限，请让管理员向您授予项目的 Workflows Admin (workflows.stepEntries.list) IAM 角色。
如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。
列出步数条目
如需列出给定工作流执行的步骤条目，请使用 projects.locations.workflows.executions.stepEntries.list 方法。默认情况下，结果按步数条目的 createTime 升序返回。
在使用任何请求数据之前，请先进行以下替换：
PROJECT_NUMBER：IAM 和管理设置页面中列出的 Google Cloud项目编号。LOCATION：在其中部署工作流的区域，例如us-central1。WORKFLOW_ID：工作流的用户定义名称，例如myFirstWorkflow。EXECUTION_ID：工作流执行的唯一 ID，在工作流执行后返回。
如需发送您的请求，请展开以下选项之一：
您应该收到类似以下内容的 JSON 响应：
{
"stepEntries": [
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/1",
"createTime": "2024-08-15T19:03:08.328807964Z",
"updateTime": "2024-08-15T19:03:08.331099694Z",
"routine": "main",
"step": "checkSearchTermInInput",
"stepType": "STEP_SWITCH",
"state": "STATE_SUCCEEDED",
"entryId": "1",
"navigationInfo": {
"children": [
"2"
],
"next": "2"
},
"variableData": {}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/2",
"createTime": "2024-08-15T19:03:08.328851864Z",
"updateTime": "2024-08-15T19:03:08.331099634Z",
"routine": "main",
"step": "checkSearchTermInInput",
"stepType": "STEP_CONDITION",
"state": "STATE_SUCCEEDED",
"entryId": "2",
"navigationInfo": {
"children": [
"3"
],
"parent": "1",
"next": "3",
"previous": "1"
},
"variableData": {}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/3",
"createTime": "2024-08-15T19:03:08.331037314Z",
"updateTime": "2024-08-15T19:03:08.331099554Z",
"routine": "main",
"step": "checkSearchTermInInput.condition1",
"stepType": "STEP_ASSIGN",
"state": "STATE_SUCCEEDED",
"entryId": "3",
"navigationInfo": {
"parent": "2",
"next": "4",
"previous": "2"
},
"variableData": {
"variables": {
"input": {
"searchTerm": "asia"
},
"searchTerm": "asia"
}
}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/4",
"createTime": "2024-08-15T19:03:08.331100404Z",
"updateTime": "2024-08-15T19:03:08.633741469Z",
"routine": "main",
"step": "readWikipedia",
"stepType": "STEP_CALL",
"state": "STATE_SUCCEEDED",
"entryId": "4",
"navigationInfo": {
"next": "5",
"previous": "3"
},
"variableData": {}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/5",
"createTime": "2024-08-15T19:03:08.633969694Z",
"updateTime": "2024-08-15T19:03:08.634063018Z",
"routine": "main",
"step": "returnOutput",
"stepType": "STEP_RETURN",
"state": "STATE_SUCCEEDED",
"entryId": "5",
"navigationInfo": {
"previous": "4"
},
"variableData": {
"variables": {
"wikiResult": {
"headers": {
...
},
"body": [
...
],
"code": 200
},
"input": {
"searchTerm": "asia"
},
"searchTerm": "asia"
}
}
}
],
"totalSize": 5
}
删除步数条目
如需删除给定工作流执行的所有步骤条目，请使用 projects.locations.workflows.executions.deleteExecutionHistory 方法。
在使用任何请求数据之前，请先进行以下替换：
WORKFLOW_NAME：工作流的名称。PROJECT_NUMBER：您的 Google Cloud项目编号。LOCATION：在其中部署此工作流的区域，例如us-central1。EXECUTION_ID：应删除相应步骤条目的执行的 ID。
如需发送您的请求，请展开以下选项之一：
如果成功，则响应正文为空。
示例
包含 for 代码块的工作流
工作流
YAML
- assignStep: assign: - sum: 0 - forStep: for: range: [1, 2] value: v steps: - sumStep: assign: - sum: ${sum + v} - returnStep: return: ${sum}
JSON
[ { "assignStep": { "assign": [ { "sum": 0 } ] } }, { "forStep": { "for": { "range": [ 1, 2 ], "value": "v", "steps": [ { "sumStep": { "assign": [ { "sum": "${sum + v}" } ] } } ] } } }, { "returnStep": { "return": "${sum}" } } ]
图示
for 代码块的工作流（点击图表可放大）。步骤条目
{ "stepEntries": [ { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/1", "createTime": "2024-08-15T19:32:18.119578307Z", "updateTime": "2024-08-15T19:32:18.119661828Z", "routine": "main", "step": "assignStep", "stepType": "STEP_ASSIGN", "state": "STATE_SUCCEEDED", "entryId": "1", "navigationInfo": { "next": "2" }, "variableData": { "variables": { "sum": 0 } } }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/2", "createTime": "2024-08-15T19:32:18.119662643Z", "updateTime": "2024-08-15T19:32:18.120893531Z", "routine": "main", "step": "forStep", "stepType": "STEP_FOR", "state": "STATE_SUCCEEDED", "entryId": "2", "navigationInfo": { "children": [ "3", "5" ], "next": "3", "previous": "1" }, "stepEntryMetadata": { "progressType": "PROGRESS_TYPE_FOR", "expectedIteration": "2" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/3", "createTime": "2024-08-15T19:32:18.119732820Z", "updateTime": "2024-08-15T19:32:18.120463449Z", "routine": "main", "step": "forStep", "stepType": "STEP_FOR_ITERATION", "state": "STATE_SUCCEEDED", "entryId": "3", "navigationInfo": { "children": [ "4" ], "parent": "2", "next": "4", "previous": "2" }, "stepEntryMetadata": { "progressType": "PROGRESS_TYPE_FOR", "progressNumber": "1" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/4", "createTime": "2024-08-15T19:32:18.119737066Z", "updateTime": "2024-08-15T19:32:18.120463358Z", "routine": "main", "step": "sumStep", "stepType": "STEP_ASSIGN", "state": "STATE_SUCCEEDED", "entryId": "4", "navigationInfo": { "parent": "3", "next": "5", "previous": "3" }, "stepEntryMetadata": { "progressType": "PROGRESS_TYPE_FOR", "progressNumber": "1" }, "variableData": { "variables": { "sum": 1, "v": 1 } } }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/5", "createTime": "2024-08-15T19:32:18.120465172Z", "updateTime": "2024-08-15T19:32:18.120893471Z", "routine": "main", "step": "forStep", "stepType": "STEP_FOR_ITERATION", "state": "STATE_SUCCEEDED", "entryId": "5", "navigationInfo": { "children": [ "6" ], "parent": "2", "next": "6", "previous": "4" }, "stepEntryMetadata": { "progressType": "PROGRESS_TYPE_FOR", "progressNumber": "2" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/6", "createTime": "2024-08-15T19:32:18.120470187Z", "updateTime": "2024-08-15T19:32:18.120893389Z", "routine": "main", "step": "sumStep", "stepType": "STEP_ASSIGN", "state": "STATE_SUCCEEDED", "entryId": "6", "navigationInfo": { "parent": "5", "next": "7", "previous": "5" }, "stepEntryMetadata": { "progressType": "PROGRESS_TYPE_FOR", "progressNumber": "2" }, "variableData": { "variables": { "sum": 3, "v": 2 } } }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-for-block/executions/0bc47b85-a399-4101-b629-1f623802e32d/stepEntries/7", "createTime": "2024-08-15T19:32:18.120894873Z", "updateTime": "2024-08-15T19:32:18.121003185Z", "routine": "main", "step": "returnStep", "stepType": "STEP_RETURN", "state": "STATE_SUCCEEDED", "entryId": "7", "navigationInfo": { "previous": "6" }, "variableData": { "variables": { "sum": 3 } } } ], "totalSize": 7 }
包含子工作流调用的工作流
工作流
YAML
main: steps: - callStep: call: square args: x: 10 result: t - retStep: return: ${t} square: params: [x] steps: - assignStep: assign: - y: ${x*x} - retStep: return: ${y}
JSON
{ "main": { "steps": [ { "callStep": { "call": "square", "args": { "x": 10 }, "result": "t" } }, { "retStep": { "return": "${t}" } } ] }, "square": { "params": [ "x" ], "steps": [ { "assignStep": { "assign": [ { "y": "${x*x}" } ] } }, { "retStep": { "return": "${y}" } } ] } }
图示
步骤条目
{ "stepEntries": [ { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-subworkflow-call/executions/e203bc96-a1cf-47ba-b6de-f3d1b0909664/stepEntries/1", "createTime": "2024-08-15T19:37:44.162778920Z", "updateTime": "2024-08-15T19:37:44.168683007Z", "routine": "main", "step": "callStep", "stepType": "STEP_CALL", "state": "STATE_SUCCEEDED", "entryId": "1", "navigationInfo": { "children": [ "2", "3" ], "next": "2" }, "variableData": { "variables": { "t": 100 } } }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-subworkflow-call/executions/e203bc96-a1cf-47ba-b6de-f3d1b0909664/stepEntries/2", "createTime": "2024-08-15T19:37:44.168598736Z", "updateTime": "2024-08-15T19:37:44.168657969Z", "routine": "square", "step": "assignStep", "stepType": "STEP_ASSIGN", "state": "STATE_SUCCEEDED", "entryId": "2", "navigationInfo": { "parent": "1", "next": "3", "previous": "1" }, "variableData": { "variables": { "y": 100, "x": 10 } } }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-subworkflow-call/executions/e203bc96-a1cf-47ba-b6de-f3d1b0909664/stepEntries/3", "createTime": "2024-08-15T19:37:44.168659349Z", "updateTime": "2024-08-15T19:37:44.168676547Z", "routine": "square", "step": "retStep", "stepType": "STEP_RETURN", "state": "STATE_SUCCEEDED", "entryId": "3", "navigationInfo": { "parent": "1", "next": "4", "previous": "2" }, "variableData": { "variables": { "x": 10, "y": 100 } } }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-subworkflow-call/executions/e203bc96-a1cf-47ba-b6de-f3d1b0909664/stepEntries/4", "createTime": "2024-08-15T19:37:44.168693503Z", "updateTime": "2024-08-15T19:37:44.168702324Z", "routine": "main", "step": "retStep", "stepType": "STEP_RETURN", "state": "STATE_SUCCEEDED", "entryId": "4", "navigationInfo": { "previous": "3" }, "variableData": { "variables": { "t": 100 } } } ], "totalSize": 4 }
包含失败步骤条目的工作流
工作流
YAML
- tryStep: try: return: ${1 / 0} except: return: 0
JSON
[ { "tryStep": { "try": { "return": "${1 / 0}" }, "except": { "return": 0 } } } ]
图示
步骤条目
{ "stepEntries": [ { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-failed-step/executions/a19d20d1-e446-4d37-b548-8005297b7d3d/stepEntries/1", "createTime": "2024-08-15T19:42:51.415433810Z", "updateTime": "2024-08-15T19:42:51.416106923Z", "routine": "main", "step": "tryStep", "stepType": "STEP_TRY_RETRY_EXCEPT", "state": "STATE_SUCCEEDED", "entryId": "1", "navigationInfo": { "children": [ "2", "4" ], "next": "2" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-failed-step/executions/a19d20d1-e446-4d37-b548-8005297b7d3d/stepEntries/2", "createTime": "2024-08-15T19:42:51.415439617Z", "updateTime": "2024-08-15T19:42:51.416065206Z", "routine": "main", "step": "tryStep", "stepType": "STEP_TRY", "state": "STATE_FAILED", "entryId": "2", "navigationInfo": { "children": [ "3" ], "parent": "1", "next": "3", "previous": "1" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-failed-step/executions/a19d20d1-e446-4d37-b548-8005297b7d3d/stepEntries/3", "createTime": "2024-08-15T19:42:51.415441815Z", "updateTime": "2024-08-15T19:42:51.416064665Z", "routine": "main", "step": "tryStep.try", "stepType": "STEP_RETURN", "state": "STATE_FAILED", "exception": { "payload": "{\"message\":\"ZeroDivisionError: division by zero\",\"tags\":[\"ZeroDivisionError\",\"ArithmeticError\"]}" }, "entryId": "3", "navigationInfo": { "parent": "2", "next": "4", "previous": "2" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-failed-step/executions/a19d20d1-e446-4d37-b548-8005297b7d3d/stepEntries/4", "createTime": "2024-08-15T19:42:51.416071869Z", "updateTime": "2024-08-15T19:42:51.416106840Z", "routine": "main", "step": "tryStep", "stepType": "STEP_EXCEPT", "state": "STATE_SUCCEEDED", "entryId": "4", "navigationInfo": { "children": [ "5" ], "parent": "1", "next": "5", "previous": "3" }, "variableData": {} }, { "name": "projects/1051295516635/locations/us-central1/workflows/workflow-failed-step/executions/a19d20d1-e446-4d37-b548-8005297b7d3d/stepEntries/5", "createTime": "2024-08-15T19:42:51.416087217Z", "updateTime": "2024-08-15T19:42:51.416106742Z", "routine": "main", "step": "tryStep.except", "stepType": "STEP_RETURN", "state": "STATE_SUCCEEDED", "entryId": "5", "navigationInfo": { "parent": "4", "previous": "4" }, "variableData": {} } ], "totalSize": 5 }