- 概述
- 开始使用
- 概念
- 使用 UiPath CLI
- 操作指南
- CI/CD 方法
- 命令参考
- 迁移
- 参考与支持
uip maestro flow debug-instances
Syntax and options for `uip maestro flow debug-instances`, a low-level debugger control surface for stepping through, inspecting, and steering a Studio Web debug session.
uip maestro flow debug-instances 是一个低级别调试器控件界面 — 创建调试实例,然后单步调试该实例,检查其变量和事件,然后取消或继续实例。这是一个与uip maestro flow debug不同、更细化的层, 在一次调用中即可上传项目并轮询完成。您可以利用 debug-instances 围绕 Studio Web 的调试协议构建自定义调试工具(例如编辑器集成),从而一次驱动一个步骤。
大纲
uip maestro flow debug-instances create --solution-id <id> --project-id <id> --entry-point <path> [--process-type <type>] [--debug-mode <mode>] [--simulation-mode <mode>] [-i, --inputs <json>]
uip maestro flow debug-instances status <instance-id>
uip maestro flow debug-instances breakpoints <instance-id> [--inputs <json|@file>]
uip maestro flow debug-instances cancel <instance-id>
uip maestro flow debug-instances continue <instance-id> [--inputs <json|@file>]
uip maestro flow debug-instances incidents <instance-id>
uip maestro flow debug-instances variables <instance-id> [--parent-element-id <id> | --expected-outputs <ids...>]
uip maestro flow debug-instances variables-set <instance-id> [--inputs <json|@file>] [--parent-element-id <id>]
uip maestro flow debug-instances variables-all <instance-id>
uip maestro flow debug-instances create --solution-id <id> --project-id <id> --entry-point <path> [--process-type <type>] [--debug-mode <mode>] [--simulation-mode <mode>] [-i, --inputs <json>]
uip maestro flow debug-instances status <instance-id>
uip maestro flow debug-instances breakpoints <instance-id> [--inputs <json|@file>]
uip maestro flow debug-instances cancel <instance-id>
uip maestro flow debug-instances continue <instance-id> [--inputs <json|@file>]
uip maestro flow debug-instances incidents <instance-id>
uip maestro flow debug-instances variables <instance-id> [--parent-element-id <id> | --expected-outputs <ids...>]
uip maestro flow debug-instances variables-set <instance-id> [--inputs <json|@file>] [--parent-element-id <id>]
uip maestro flow debug-instances variables-all <instance-id>
debug-instance is an alias of debug-instances.
uip maestro flow debug-instances create
在 Orchestrator 中开始调试会话,并为已上传的解决方案创建相应的调试实例。
选项
| 选项 | 必填 | 默认 | 描述 |
|---|---|---|---|
--solution-id <id> | 是 | — | 上一次上传的解决方案或 Studio Web 中的解决方案 ID。 |
--project-id <id> | 是 | — | 解决方案中的 Studio Web 项目 ID。 |
--entry-point <path> | 是 | — | 入口点路径,例如/Main.bpmn#start。 |
--process-type <type> | 否 | processOrchestration | 流程类型。 |
--debug-mode <mode> | 否 | Default | Default (在断点处暂停)、StepByStep(在每一步暂停)或 SingleStep(只执行一个步骤)。 |
--simulation-mode <mode> | 否 | None | None、All(模拟每个元素)或 Selective(模拟除选择退出以外的元素)。 |
-i, --inputs <json> | 否 | {} | JSON 字符串形式的输入参数。 |
无效的 --debug-mode/--simulation-mode 值快速失败,列出有效的集合。
数据形状
{
"Code": "DebugInstanceCreated",
"Data": {
"instanceId": "…",
"runId": "…",
"jobKey": "b2c3d4e5-…"
},
"Instructions": "Use 'debug-instances status <instance-id>' to check the run. Use 'debug-instances incidents <instance-id>' or 'debug-instances variables <instance-id>' to inspect it."
}
{
"Code": "DebugInstanceCreated",
"Data": {
"instanceId": "…",
"runId": "…",
"jobKey": "b2c3d4e5-…"
},
"Instructions": "Use 'debug-instances status <instance-id>' to check the run. Use 'debug-instances incidents <instance-id>' or 'debug-instances variables <instance-id>' to inspect it."
}
uip maestro flow debug-instances status
获取每个元素的执行状态。参数:<instance-id>。数据形状:Code: "DebugInstanceStatus"。
uip maestro flow debug-instances breakpoints
更新为已暂停实例设置的断点。参数:<instance-id>。选项:--inputs <value> — 将有效负载断点为 JSON 字符串、@file 路径或通过标准输入管道传输。数据形状:Code: "DebugInstanceBreakpointsUpdated"。
uip maestro flow debug-instances cancel
取消调试实例。参数:<instance-id>。数据形状:Code: "DebugInstanceCanceled"。
uip maestro flow debug-instances continue
在暂停的实例上继续执行。参数:<instance-id>。选项:--inputs <value> — JSON 字符串、@file 路径或标准输入;省略时默认为 {"nextStep": false}(运行到下一个断点,而不是单个步骤)。数据形状:Code: "DebugInstanceContinued"。
uip maestro flow debug-instances incidents
获取调试会话期间引发的事件。参数:<instance-id>。数据形:Code: "DebugInstanceIncidents",Data 是一个数组(如果没有,则为空)。
uip maestro flow debug-instances variables
获取实例的变量。参数: <instance-id> 。选项:
--parent-element-id <id>— 筛选,以查看单个元素下的变量。--expected-outputs <ids...>— 记录必须定义的输出变量 ID,以空格分隔。读取可以在运行的输出变量存在之前返回;使用此选项时,系统将再次读取未定义任何列出的 ID 的记录,并且如果命令从未定义这些 ID,则该命令将失败。不能与--parent-element-id结合使用,因为声明的输出存在于实例的根记录中。当无法读取已完成的运行的输出时,uip maestro flow debug使用每个声明的输出 ID 命名此选项。
数据形状: Code: "DebugInstanceVariables" 。
uip maestro flow debug-instances variables-set
修补(部分更新)变量。参数: <instance-id> 。选项: --inputs <value> — 将补丁有效负载作为 JSON 字符串、 @file路径或标准输入; --parent-element-id <id> — 将补丁的范围限制为父元素 ID。数据形状: Code: "DebugInstanceVariablesSet" 。
uip maestro flow debug-instances variables-all
获取所有变量,包括子流程作用域。参数:<instance-id>。数据形状:Code: "DebugInstanceVariablesAll"。
另请参阅
uip maestro flow debug— 大多数工作流应改用的更高级别的“上传并轮询”调试命令uip maestro flow instances— 已发布、正在运行的实例的等效控件界面,而非调试会话- 流概述
- 全局选项、退出代码
- 大纲
- uip maestro flow debug-instances create
- 选项
- 数据形状
- uip maestro flow debug-instances status
- uip maestro flow debug-instances breakpoints
- uip maestro flow debug-instances cancel
- uip maestro flow debug-instances continue
- uip maestro flow debug-instances incidents
- uip maestro flow debug-instances variables
- uip maestro flow debug-instances variables-set
- uip maestro flow debug-instances variables-all
- 另请参阅