uip Maestro 流作业

“uip Maestro 流程作业”的语法和选项，可流式传输单个流程作业的执行追踪记录并获取详细状态。

uip maestro flow job通过流式传输追踪或获取详细状态，检查单个Flow 作业- 流程实例的一次执行尝试。

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

大纲

uip maestro flow job list  [--folder-key <key>] [--state <state>] [--process-name <name>]
                    [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
                    [--login-validity <minutes>]

uip maestro flow job traces <job-key>
                    [--poll-interval <ms>]
                    [--traces-service <name>] [--pretty]
                    [--login-validity <minutes>]

uip maestro flow job status <job-key>
                    [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]

uip Maestro 流作业列表

列出文件夹中的 Flow 作业。

选项

选项	默认	描述
--folder-key <key>	经过身份验证的文件夹	文件夹密钥 (GUID)。
--state <state>	—	按作业状态筛选：Pending、Running、Successful、Faulted、Stopped、Stopping、Suspended、Resumed、Terminating。
--process-name <name>	—	按 Flow 流程名称筛选（包含匹配项）。
-l, --limit <n>	50	要返回的项目数。
--offset <n>	0	要跳过的项目数量。
--sort-by <field>	服务器默认值	按字段对结果进行排序，例如'Id desc'。
--all-fields	关闭	返回 API 响应中的所有字段，而不是策划摘要。
--login-validity <minutes>	10	令牌刷新阈值。

示例

uip maestro flow job list --folder-key c3d4e5f6-… --limit 2

数据形状（默认摘要）

{
  "Code": "FlowJobList",
  "Data": [
    {
      "key": "b2c3d4e5-…",
      "state": "Successful",
      "processName": "InvoiceFlow",
      "source": "Manual",
      "startTime": "2025-04-15T10:30:00Z",
      "endTime": "2025-04-15T10:32:11Z"
    }
  ]
}

使用 --all-fields，每个项目都包含完整的 Orchestrator 作业对象，而不是此策划摘要。

uip Maestro 流作业追踪

正在运行或最近完成的作业的流执行追踪事件。行到达时流式传输到 STDERR；最终状态和持续时间也会流式传输。

参数

• <job-key> （必填） — 作业密钥（来自process run GUID）。

选项

选项	默认	描述
--poll-interval <ms>	2000	轮询间隔。必须为正数。
--traces-service <name>	llmopstenant_	追踪服务名称（高级；仅在收到指示时覆盖）。
--pretty	关闭	美化追踪事件。如果没有它，每个事件都作为单个 JSON 行发出，适合通过管道传输到jq 。
--login-validity <minutes>	10	令牌刷新阈值。

行为

• 将标题行写入 标准错误： Streaming traces for job: <key> Polling every Ns...
• 通过ScreenLogger.progress (stderr) 流式传输每个追踪事件。
• 完成后，发出Job <key>: <finalState> (<durationMs>ms) 。
• 退出代码：如果作业成功，则为0 ；否则为1 （根据result.success ）。

示例

# Raw JSON lines — best for piping
uip maestro flow job traces b2c3d4e5-… | jq -c 'select(.level=="error")'

# Human-readable
uip maestro flow job traces b2c3d4e5-… --pretty

# Slower polling for quiet jobs
uip maestro flow job traces b2c3d4e5-… --poll-interval 5000

输出：直接流式传输追踪记录 — 没有最终的Data有效负载。

uip Maestro 流作业状态

获取 Flow 作业的状态。默认情况下返回策划的 14 个字段的摘要； --detailed返回完整的 Orchestrator 响应。

参数

• <job-key> （必填） — 作业密钥 (GUID)。

选项

选项	默认	描述
--folder-key <key>	经过身份验证的文件夹	文件夹密钥 (GUID)。
--detailed	关闭	返回完整的响应，而不是包含 14 个字段的摘要。
--login-validity <minutes>	10	令牌刷新阈值。

数据形状（默认摘要）

{
  "Code": "FlowJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "Flow",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceFlow",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}

对于--detailed ， Data是完整的 Orchestrator 作业对象（所有字段，未展平）。

备注：

完整的详细响应形状是 Orchestrator 返回的任何内容，并非严格由 CLI 键入。字段存在状态可能会在 Orchestrator 版本之间发生偏移，适用于解析特定字段、防御性查询以及在 CI 中固定@uipath/cli脚本。

示例

# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "<folder-key>" \
           --inputs '{}' --output-filter "jobKey" --output plain)
uip maestro flow job traces "$JOB_KEY" --pretty

# Get the summary once the job is done
uip maestro flow job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip maestro flow job status "$JOB_KEY" --detailed

另请参阅

• uip maestro flow process run — 开始作业
• uip maestro flow instance — 同一执行的实例视图
• Orchestrator 作业
• 流概述