UIP 或作业

“uip 或作业”的语法和选项，用于启动、停止、重新启动和检查 Orchestrator 流程执行及其日志。

uip or jobs用于管理流程执行：从流程中启动作业，停止和重新启动作业，继续暂停的作业，以及检查日志、追踪记录、修复智能体数据和状态历史记录。每个作业都由全局唯一的 GUID 密钥标识，大多数动词会自动从密钥中解析文件夹。

大纲

uip or jobs <verb> [options]

动词

动词	用途
list	列出作业，可以将作业范围限定在文件夹内，并可以按状态、流程、来源或时间范围进行筛选。
get	按键获取一个作业，包括输入/输出参数和（对于待处理作业）诊断原因。
start	为流程启动一个或多个作业； （可选）等待完成并下载输出。
stop	软停止或强制终止一个或多个正在运行/待处理的作业。
restart	从发生故障或已停止的作业创建新作业。
resume	继续暂停的作业，并可选择使用更新的输入参数。
logs	获取作业的机器人执行日志；按级别筛选或导出为 CSV。
traces	获取智能体（智能体类型）作业的 LlmOps 执行追踪记录。
healing-data	将 Healing Agent 恢复数据（屏幕截图、用户界面数据、日志）下载为 ZIP 文件。
history	显示作业的状态转换。

uip 或作业列表

列出文件夹中的作业或包含 --all-folders 的每个可访问文件夹中的作业。返回作业键、状态、流程名称、时间和计算机信息。仅需要文件夹选取器 (--folder-path/--folder-key) 或 --all-folders 其中一个 — 该命令拒绝运行同时使用两者或不使用两者。

选项

短	长	值	默认	描述
—	--folder-path	路径	—	按路径将范围限定到文件夹（例如 Shared）。提供此变量、--folder-key 或 --all-folders。
—	--folder-key	GUID	—	按键作用域到文件夹。
—	--all-folders	标记	关闭	列出每个可访问文件夹中的作业。与文件夹选取器互斥。
—	--state	枚举	—	Pending、 Running 、 Successful 、 Faulted 、 Stopped 、 Stopping 、 Suspended 、 Resumed 、 Terminating 。
—	--process-name	text	—	流程（发布）名称的包含匹配项。
—	--source	枚举	—	按作业来源类型筛选（例如， Manual 、 Schedule 、 Queue 、 Agent ）。
—	--created-after	ISO 8601	—	在此日期/时间或之后创建的作业。
—	--created-before	ISO 8601	—	严格在此日期/时间之前创建的作业。
—	--started-after	ISO 8601	—	作业在此日期/时间或之后开始。
—	--started-before	ISO 8601	—	作业严格在此日期/时间之前开始。
—	--ended-after	ISO 8601	—	作业已在此日期/时间或之后结束。
—	--ended-before	ISO 8601	—	作业严格在此日期/时间之前结束。
-l	--limit	数字	50	页面大小。
—	--offset	数字	0	跳过计数。
—	--sort-by	字段	Id desc	OData 排序表达式。
—	--all-fields	标记	关闭	返回完整的 API 有效负载，而不是策划摘要。

示例

# The 50 most recent jobs across every accessible folder
uip or jobs list --all-folders

# Running jobs in a specific folder, newest first
uip or jobs list --folder-path "Shared" --state Running

# Pull only job keys and states, script-friendly
uip or jobs list --all-folders --state Faulted --limit 200 \
    --output-filter 'Data[].{key:Key, state:State}'

数据形状（--输出 json）

{
  "Code": "JobList",
  "Data": [
    {
      "Key": "b2c3d4e5-0000-0000-0000-000000000001",
      "State": "Running",
      "ProcessName": "InvoiceProcessing",
      "ReleaseKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "Source": "Manual",
      "Type": "Unattended",
      "Priority": "Normal",
      "Machine": "prod-worker-01",
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "StartTime": "2025-04-15T10:30:00Z",
      "EndTime": "",
      "CreationTime": "2025-04-15T10:29:55Z"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

UIP 或 Jobs Get

通过 GUID 密钥获取一项作业。发生故障时，返回状态、输入/输出参数、时间、计算机信息和错误详细信息。如果作业的状态为Pending ，则输出还包含PendingReasons （API 的诊断报告，说明作业未开始的原因 - 机器人可用性、容量等）。不需要文件夹上下文。

如果作业具有OutputFile ，则会作为output-<job-key>.dat自动下载到当前目录（或--output-dir ）中。传递--no-download可跳过。

参数

名称	必填	用途
<job-key>	是	作业密钥 (GUID)。使用uip or jobs list查找。

选项

短	长	值	默认	描述
—	--output-dir	路径	当前目录	下载的OutputFile的目录。
—	--no-download	标记	关闭	跳过自动OutputFile下载。
—	--all-fields	标记	关闭	返回完整的 API 有效负载。

示例

uip or jobs get b2c3d4e5-0000-0000-0000-000000000001

# Skip the output-file download (useful in read-only containers)
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 --no-download

# Extract just output arguments
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.OutputArguments'

数据形状（--输出 json）

{
  "Code": "JobGet",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "ReleaseName": "InvoiceProcessing",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:32:11Z",
    "InputArguments": "{\"invoicePath\":\"/data/inv.pdf\"}",
    "OutputArguments": "{\"result\":\"Processed\"}",
    "HostMachineName": "prod-worker-01",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

uip 或作业启动

为流程启动一个或多个作业。<process-key>是uip or processes list返回的 GUID（不是packages list ）。文件夹是可选的 — 如果--folder-path和--folder-key都未提供，则根据流程推断得出。

在开始之前，使用uip or packages entry-points查看包版本的输入/输出参数架构。

参数

名称	必填	用途
<process-key>	是	uip or processes list处理（发布）密钥 (GUID)。

选项

身份和租户

短	长	值	默认	描述
—	--folder-path	路径	已推断	文件夹路径；如果省略，则从流程中推断得出。
—	--folder-key	GUID	已推断	文件夹密钥；如果省略，则从流程中推断得出。

执行策略

短	长	值	默认	描述
—	--strategy	枚举	ModernJobsCount	ModernJobsCount、 All 、 Specific 、 JobsCount 。
—	--jobs-count	数字	1	要创建的作业数量（用于基于计数的策略）。
—	--runtime-type	枚举	文件夹配置	Unattended、 Headless 、 Serverless 、 NonProduction 、 Development 、 TestAutomation 。
—	--job-priority	枚举	—	Low、 Normal 、 High 、
—	--reference	text	—	存储在作业中的自由格式参考字符串。
—	--run-as-me	标记	关闭	以调用者的身份运行。
—	--healing-agent	标记	关闭	为此运行启用 Healing Agent (Autopilot for Robots)，以便从选取器故障和类似的 runtime 错误中恢复。必须已启用租户级别的 Autopilot。
—	--user-keys	CSV	—	要运行的用户 GUID（解析为无人值守机器人）。
—	--machine-keys	CSV	—	要定位的计算机 GUID。

输入和附件

短	长	值	默认	描述
—	--input-arguments	JSON	—	内联 JSON 有效负载。超过 10,000 字符时自动卸载到InputFile 。与--input-file互斥。
—	--input-file	路径	—	上传文件作为作业的InputFile 。与--input-arguments互斥。
—	--attachment	[name=]path	—	上传文件并附加该文件。可重复。--attachment ./doc.pdf从文件名中自动命名； --attachment invoice=./report.pdf设置显式名称。
—	--attachment-id	GUID	—	按 ID 附加现有附件。可重复。查找带有attachments list --job-key ID。
—	--environment-variables	text	—	以换行符分隔的 KEY=VALUE 对形式的环境变量（非 JSON）。提交前已验证。

正在等待完成

短	长	值	默认	描述
—	--wait-for-completion	标记	关闭	轮询直到作业到达Successful 、 Faulted或Stopped 。
—	--timeout	秒	300	最长等待时间（需要--wait-for-completion ）。
—	--poll-interval	秒	5	轮询间隔（需要--wait-for-completion ）。
—	--output-dir	路径	当前目录	保存位置OutputFile （需要--wait-for-completion ）。
—	--no-download	标记	关闭	跳过OutputFile下载（需要--wait-for-completion ）。

备注：

--user-keys将每个用户 GUID 解析为目标文件夹中的无人值守机器人。系统会筛选出 Attended 和 AttendedStudioWeb Robot 类型——通过 CLI 启动的作业需要 Unattended Robot。如果此文件夹中不存在用户的 Unattended Robot，则命令将失败。

示例

# Minimal — start one job for a process
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001

# Start with input arguments and wait for completion
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-arguments '{"invoicePath":"/data/inv.pdf"}' \
    --wait-for-completion --timeout 600

# Upload a file as input and attach a supporting document
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-file ./payload.json \
    --attachment invoice=./report.pdf

数据形状（--输出 json）

没有--wait-for-completion ：

{
  "Code": "JobStarted",
  "Data": {
    "Jobs": [
      {
        "Key": "b2c3d4e5-0000-0000-0000-000000000099",
        "State": "Pending",
        "ProcessName": "InvoiceProcessing",
        "Source": "Manual",
        "Type": "Unattended",
        "Priority": "Normal",
        "Machine": "",
        "StartTime": "",
        "EndTime": "",
        "CreationTime": "2025-04-15T10:29:55Z"
      }
    ]
  }
}

对于--wait-for-completion ， Code为JobCompleted （如果失败，则为JobFaulted ），而Data形状与jobs get加上Duration字段相同。如果作业发生故障，流程将退出，并显示代码1 。

动词专属退出代码覆盖

• --wait-for-completion + 作业以Faulted结尾：即使命令成功观察结果，也会退出1 。
• --wait-for-completion + 达到超时：使用1退出Instructions ，以便使用jobs get进行轮询。

uip 或作业停止

停止一个或多个正在运行或待处理的作业。使用单键时，遵循--strategy （ SoftStop或Kill ”）。如果有多个键，则始终通过批量 API 强制停止（终止）— 在这种情况下， --strategy会被忽略。无需文件夹上下文；从第一个作业键解析。

参数

名称	必填	用途
<job-keys...>	是	一个或多个作业密钥 (GUID)。

选项

短	长	值	默认	描述
—	--strategy	枚举	SoftStop	SoftStop （从容）或Kill （立即）。仅适用于单键站点。

示例

uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001
uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001 --strategy Kill
uip or jobs stop key-1 key-2 key-3   # bulk force-stop

数据形状（--输出 json）

单键：

{
  "Code": "JobStopped",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "Strategy": "SoftStop",
    "Status": "Stop requested"
  }
}

多个键返回带有Code: "JobsStopped" JobKeys 、 Strategy: "Kill (force stop)"和Status字符串的 。

uip 或作业重新启动

从发生故障或已停止的作业创建新作业。文件夹根据作业密钥解析。

参数

名称	必填	用途
<job-key>	是	要重新启动的作业密钥 (GUID)。

选项

短	长	值	默认	描述

示例

uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001
uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001 --output-filter 'Data.Key'

数据形状（--输出 json）

{
  "Code": "JobRestarted",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000050",
    "State": "Pending",
    "ProcessName": "InvoiceProcessing",
    "Status": "Restart requested"
  }
}

uip 或作业将继续

继续已暂停的作业。当作业在长时间运行的工作流中使用Suspend活动时，作业将暂停。（可选）传递新的--input-arguments以继续使用更新的数据。

参数

名称	必填	用途
<job-key>	是	要继续的作业密钥 (GUID)。

选项

短	长	值	默认	描述
—	--input-arguments	JSON	—	替换输入参数。

示例

uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001
uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001 \
    --input-arguments '{"approved":true}'

数据形状（--输出 json）

{
  "Code": "JobResumed",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Resumed",
    "ProcessName": "ApprovalFlow",
    "Status": "Resume requested"
  }
}

UIP 或作业日志

获取作业的机器人执行日志。日志按最新顺序返回。使用--level按严重性筛选。使用--export时，日志将在服务器端导出为 CSV，并在准备就绪时下载。

参数

名称	必填	用途
<job-key>	是	作业密钥 (GUID)。在调用任何 API 之前，作为 UUID 进行验证。

选项

短	长	值	默认	描述
—	--level	枚举	—	Fatal、 Error 、 Warning 、 Info 、 Trace 。
-l	--limit	数字	50	页面大小。
—	--offset	数字	0	跳过计数。
—	--export	标记	关闭	通过服务器端导出 API 导出为 CSV。
-o	--output	路径	robot-logs-<job-key>.csv	输出 CSV 路径。仅适用于--export 。

示例

uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --level Error --limit 100
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --export -o ./run.csv
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 \
    --level Error --output-filter 'Data[].Message'

数据形状（--输出 json）

内联模式：

{
  "Code": "JobLogs",
  "Data": [
    {
      "Level": "Error",
      "TimeStamp": "2025-04-15T10:31:02Z",
      "Message": "Selector not found: ctrl[name='submit']"
    }
  ]
}

--export会针对JobKey 、 FileName 、 Size和ExportId发出Code: "JobLogsExported" 。

UIP 或作业追踪

获取智能体作业的 LlmOps 执行追踪记录，包括 LLM 交互、工具调用和智能体决策。仅适用于智能体类型流程。文件夹根据作业密钥解析。

参数

名称	必填	用途
<job-key>	是	作业密钥 (GUID)。

选项

短	长	值	默认	描述

示例

uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001
uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.messages'

数据形状（--输出 json）

原始 API 有效负载在Data下原样传递：

{
  "Code": "JobTraces",
  "Data": { "...": "raw LlmOps trace payload" }
}

uip 或作业修复数据

将 Healing Agent (Autopilot for Robots) 恢复数据下载为 ZIP 文件：屏幕截图、用户界面元素数据和恢复日志。仅适用于 Healing Agent 处于活动状态的作业。该命令会触发异步导出，轮询导出 API，直至完成，然后下载生成的 ZIP 文件。

参数

名称	必填	用途
<job-key>	是	作业密钥 (GUID)。

选项

短	长	值	默认	描述
—	--directory-prefix	前缀	—	路径前缀筛选器已应用于导出的文件。
-o	--output	路径	healing-agent-data-<job-key>.zip	输出 ZIP 路径。

示例

uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    -o ./recovery.zip
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.FileName'

数据形状（--输出 json）

{
  "Code": "JobHealingData",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "FileName": "healing-agent-data-b2c3d4e5-0000-0000-0000-000000000001.zip",
    "Size": 254318,
    "ExportId": 4711
  }
}

备注：

系统会以 2 秒的间隔轮询服务器端导出最多 30 次（共 60 秒）。如果未在该窗口中完成，该命令将使用导出 ID 退出1 ，以便重试。

uip 或作业历史记录

获取作业的状态转换历史记录（ Pending → Running → Successful / Faulted ）。文件夹根据作业密钥解析。

参数

名称	必填	用途
<job-key>	是	作业密钥 (GUID)。

选项

短	长	值	默认	描述

示例

uip or jobs history b2c3d4e5-0000-0000-0000-000000000001
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data[].{state:State, ts:Timestamp}'
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 --output table

数据形状（--输出 json）

{
  "Code": "JobHistory",
  "Data": [
    { "State": "Pending", "Timestamp": "2025-04-15T10:29:55Z", "JobId": 1001 },
    { "State": "Running", "Timestamp": "2025-04-15T10:30:00Z", "JobId": 1001 },
    { "State": "Successful", "Timestamp": "2025-04-15T10:32:11Z", "JobId": 1001 }
  ]
}

退出代码

请参阅共享合同的退出代码。动词专属覆盖：

• 如果观察到的作业结束Faulted或等待超时， jobs start --wait-for-completion将退出1 。
• 如果服务器端导出未在 60 秒左右完成， jobs healing-data将退出1 。

相关命令

• uip or processes — 管理jobs start所针对的流程（发布）绑定。
• uip or packages — 特别是packages entry-points ，用于发现输入/输出参数架构。
• uip or attachments — 列出和下载作业附件。
• uip or users — 将用户名解析为--user-keys键。
• uip or machines — 将计算机名称解析为--machine-keys键。

另请参阅

• 全局选项— --output 、 --output-filter 、 --log-level 、 --log-file 。
• 会话— 如何解析租户和文件夹上下文。
• 您的第一个管道— 使用jobs start --wait-for-completion端到端演练。