uip Maestro bpmn 实例

“uip Maestro bpmn 实例”的语法和选项，用于检查和控制单个 Maestro BPMN 流程实例。

uip maestro bpmn instance检查和控制单个流程实例— 已发布的 Maestro BPMN 流程的执行。即使侧边栏条目显示为 instance，命令名称也为单数 (instances)。此处的每个动词都在 bpmn 分支下注册 — 没有空的 uip maestro bpmn instance。

所有子命令都需要uip login并遵循全局选项。退出代码遵循标准合同。

大纲

uip maestro bpmn instance list                                  -f <folder-key> [-l <limit>] [--next-page <cursor>] [--process-key <guid>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso>] [--to-date <iso>]
uip maestro bpmn instance get                 <instance-id>     -f <folder-key>
uip maestro bpmn instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro bpmn instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro bpmn instance variables-set       <instance-id>     -f <folder-key> --inputs <json|@file>
uip maestro bpmn instance variables-all       <instance-id>     -f <folder-key>
uip maestro bpmn instance global-variables    <instance-id>     -f <folder-key>
uip maestro bpmn instance incidents           <instance-id>     -f <folder-key>
uip maestro bpmn instance asset               <instance-id>     -f <folder-key>
uip maestro bpmn instance cursors             <instance-id>     -f <folder-key>
uip maestro bpmn instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro bpmn instance element-executions  <instance-id>     -f <folder-key>
uip maestro bpmn instance message send                          -f <folder-key> --inputs <json|@file>
uip maestro bpmn instance element cancel      <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro bpmn instance element retry       <instance-id> <element-id> -f <folder-key> [--comment <text>]

每个子命令都需要-f, --folder-key <key> 。

常见选项

• -f, --folder-key <key> （必填） — 文件夹密钥 (GUID)。
• --comment <text> （仅限操作命令） — 与操作一起记录的可选注释。如果省略，则作为空字符串发送。

子命令

uip Maestro bpmn 实例列表

列出文件夹中以 processType=ProcessOrchestration 为范围的实例。筛选器在服务器端应用。按光标逐页显示的结果，未偏移 — 从响应中读取 Pagination.NextPage，并通过 --next-page 将其回传。

选项

选项	默认	描述
-l, --limit <n>	DEFAULT_PAGE_SIZE	要返回的项目数 (1-500)。
--next-page <cursor>	—	上一个响应的 Pagination.NextPage 中的光标。
--offset <n>	—	不受此 API 支持。 --offset 0 静默接受为无操作（相当于无光标）；使用任何其他值都会失败，并显示错误，提示您改用 --next-page。
--process-key <guid>	—	按流程筛选 — 必须是 GUID。对于点分包标识符（例如InvoiceOrchestration:1.0.0），如果 uip or processes list 打印为 ProcessKey，请改用 --package-id。
--package-id <id>	—	按包 ID（点分包标识符）筛选。
--error-code <code>	—	按错误代码筛选。
--status <status>	—	按实例状态筛选。可重复，“OR”语义。无效的值无法快速列出接受的集。
--from-date <iso-8601>	—	仅包含在此时间戳当天或之后开始的实例，例如2026-01-01T00:00:00Z。
--to-date <iso-8601>	—	仅包含在此时间戳不高于其开始的实例。

数据形状

Code: "InstanceList"、Data 是流程实例对象数组加上 Pagination 块（returned、limit、hasMore 和 nextPage）。

uip Maestro bpmn 实例获取

按 ID 获取单个实例。数据形状： Code: "InstanceGet" ， Data是流程实例对象。

uip Maestro bpmn 实例暂停

暂停正在运行的实例。数据形状： Code: "InstancePaused" 。

uip Maestro bpmn 实例继续

恢复已暂停的实例。数据形状： Code: "InstanceResumed" 。

uip Maestro bpmn 实例取消

取消正在运行的实例。数据形状： Code: "InstanceCanceled" 。

uip Maestro bpmn 实例重试

重试发生故障的实例。数据形状： Code: "InstanceRetried" 。

uip Maestro bpmn 实例迁移

将实例迁移到其他包版本。

参数： <instance-id> 、 <new-version> （目标包版本）。

数据形状： Code: "InstanceMigrated" 。

uip Maestro bpmn 实例变量

获取实例的变量。

选项： --parent-element-id <id> — 按父元素筛选变量。

数据形状： Code: "InstanceVariables" ， Data包含实例变量有效负载。

uip Maestro bpmn 实例变量集

为正在运行的实例修补（更新）变量。

选项

选项	描述
--inputs <value>	Patch 变量有效负载作为 JSON 字符串、@file 路径或通过标准输入管道传输。必需（如果没有有效负载解析，则命令将失败）。

数据形状

Code: "InstanceVariablesSet"。

uip Maestro bpmn 实例变量-全部

获取实例的所有变量，包括子流程变量。

数据形状： Code: "InstanceVariablesAll" 。

uip Maestro bpmn 实例全局变量

获取实例的全局变量。

数据形状： Code: "InstanceGlobalVariables" 。

uip Maestro bpmn 实例事件

数据形状： Code: "InstanceIncidents" ， Data是事件对象数组。

uip Maestro bpmn 实例资产

获取附加到此实例版本的 BPMN 资产。

数据型： Code: "InstanceAsset" ， Data是 BPMN 资产有效负载。

uip Maestro bpmn 实例光标

获取当前执行光标位置 — 实例暂停的元素。

数据形状： Code: "InstanceCursors" 、 Data列出当前光标位置。

uip Maestro bpmn 实例转到

将执行光标从一个元素移动到另一个元素。

参数

• <instance-id> （必填项）
• <transitions> （必填） — 转换的 JSON 数组，每个转换都包含sourceElementId和targetElementId 。

uip maestro bpmn instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…

数据形状

Code: "InstanceGoto"。

uip Maestro bpmn 实例元素执行

获取实例每个元素的执行历史记录。

数据形状

Code: "InstanceElementExecutions" ， Data是每个元素的执行历史记录。

uip Maestro bpmn 实例消息发送

向侦听此流程的工作流订阅发送消息 — 不限定于单个实例 ID；供应商有效负载决定了消息消息会到达哪些实例。

选项

选项	必填	描述
-f, --folder-key <key>	是	文件夹密钥 (GUID)。
--inputs <value>	—	消息有效负载为 JSON 字符串、@file 路径，或通过标准输入管道传输。如果没有可解析的有效负载，则失败。

数据形状

Code: "MessageSent"。

uip Maestro bpmn 实例元素“取消”

取消正在运行的实例中的一个元素，而不取消整个实例。

参数

• <instance-id> （必填项）
• <element-id> （必填项）

选项

选项	描述
-f, --folder-key <key>	文件夹密钥 (GUID)。必需。
--comment <text>	操作的可选注释。

数据形状

Code: "ElementCanceled"。

uip Maestro bpmn 实例元素重试

重试实例中发生故障的元素。

参数

• <instance-id> （必填项）
• <element-id> （必填项）

选项

选项	描述
-f, --folder-key <key>	文件夹密钥 (GUID)。必需。
--comment <text>	操作的可选注释。

数据形状

Code: "ElementRetried"。

示例

# Paginate through instances for a specific process, filtered by status
uip maestro bpmn instance list --folder-key <k> \
  --status Faulted --status Paused --limit 50

# Page through with the cursor from a previous response
uip maestro bpmn instance list --folder-key <k> --next-page <cursor>

# Pause, fix, resume
uip maestro bpmn instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro bpmn instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro bpmn instance cursors <id> --folder-key <k>
uip maestro bpmn instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro bpmn instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro bpmn instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"

# Retry a single faulted element instead of the whole instance
uip maestro bpmn instance element retry <id> Activity_2 --folder-key <k>

# Patch a variable on a running instance
uip maestro bpmn instance variables-set <id> --folder-key <k> --inputs '{"amount": 250}'

另请参阅

• uip maestro bpmn incidents — 与特定实例分离的事件
• uip maestro bpmn job — 实例运行的作业视图
• uip maestro bpmn process — 启动新实例
• Orchestrator 作业
• Maestro 概述