uip 评估计划

“uip eval Schedule”的语法和选项，可创建、列出、更新、暂停、继续和删除 Orchestrator 流程的定期评估运行计划。

uip eval schedule 管理 Orchestrator 流程的定期评估运行：创建一个由 CRON 触发的计划，该计划按计时器运行流程中的给定评估集，然后列出、检查、更新、暂停、继续或删除流程。这是一次性运行的计划对应 — 请参阅uip eval以了解整个eval子系统，包括execute-and-evaluate （同步运行一次）和run （检查过去的运行）。有关评估集实际包含的内容，请参阅uip eval eval-set 。

每个计划都属于一个流程 (--process-key)，并对包含五个字段的 UTC CRON 表达式运行一个评估集 (--eval-set-id)。

大纲

uip eval schedule create  --process-key <guid> --eval-set-id <guid> --cron <expr> [--workload-id <guid>] [--folder-key <guid>] [--tenant <tenant>]
uip eval schedule list    --process-key <guid> [--tenant <tenant>]
uip eval schedule get     <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule update  <schedule-id> --process-key <guid> [--eval-set-id <guid>] [--cron <expr>] [--tenant <tenant>]
uip eval schedule pause   <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule resume  <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule delete  <schedule-id> --process-key <guid> [--tenant <tenant>]

动词

动词	用途
create	为流程创建新的定期计划。
list	列出流程的每个计划。
get	按 ID 获取一个计划。
update	更改计划的评估集和/或 CRON 表达式。
pause	暂停活动计划。
resume	恢复已暂停的计划。
delete	删除计划。

uip 评估计划创建

创建一个计划，对 UTC CRON 触发器上的流程运行评估集。

如果省略 --workload-id 或 --folder-key，则该命令会首先查找评估集 (GET .../evalSets/<eval-set-id>) ，并从中填写评估集 — 您只需显式传递它们以覆盖该解决方案。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥（部署 GUID）— 标识 Orchestrator 版本。
—	--workload-id	GUID	通过评估集解决	工作负载 ID。
—	--eval-set-id	GUID	—	必需。设置为在每个触发器上运行的评估。
—	--cron	CRON 表达式	—	必需。有五个字段的 CRON 表达式，以 UTC 时间求值（例如 "0 9 * * *" 表示每天上午 9 点 UTC）。
—	--folder-key	GUID	通过评估集解决	Orchestrator 文件夹密钥。
—	--tenant	name	会话默认值	UiPath 租户名称。普通选项，未弃用。

示例

# Daily at 9 AM UTC
uip eval schedule create --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 \
  --eval-set-id f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04 --cron "0 9 * * *"

数据形状（--输出 json）

{
  "Code": "EvalScheduleCreated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

仅在计划至少更改一次后，UpdatedAt 才存在（新的 create 响应中不存在）。

uip 评估计划列表

列出为流程注册的所有计划。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥。
—	--tenant	name	会话默认值	UiPath 租户名称。

示例

uip eval schedule list --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

数据形状（--输出 json）

{
  "Code": "EvalScheduleList",
  "Data": [
    {
      "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
      "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
      "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
      "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
      "CronExpression": "0 9 * * *",
      "Status": "active",
      "CreatedAt": "2025-04-15T10:29:55Z"
    }
  ]
}

uip 评估计划获取

按 ID 获取一个计划。

参数

名称	必填	用途
<schedule-id>	是	计划 GUID，来自 create 或 list。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥。
—	--tenant	name	会话默认值	UiPath 租户名称。

示例

uip eval schedule get b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

数据形状（--输出 json）

{
  "Code": "EvalScheduleDetails",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

uip 评估计划更新

更改计划的评估集和/或 CRON 表达式。--eval-set-id/--cron 中至少有一项为必要项——在任何网络调用之前，客户端均不会失败。

参数

名称	必填	用途
<schedule-id>	是	计划更新。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥。
—	--eval-set-id	GUID	—	新的评估集。这或 --cron 至少有一个为必需。
—	--cron	CRON 表达式	—	新的五字段 CRON 表达式 (UTC)。这或 --eval-set-id 至少有一个为必需。
—	--tenant	name	会话默认值	UiPath 租户名称。

示例

uip eval schedule update b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --cron "0 */6 * * *"

数据形状（--输出 json）

{
  "Code": "EvalScheduleUpdated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 */6 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z",
    "UpdatedAt": "2025-04-16T08:00:00Z"
  }
}

同时省略 --eval-set-id 和 --cron 将失败，并显示：

{
  "Result": "Failure",
  "Message": "At least one of --eval-set-id or --cron must be provided.",
  "Instructions": "Provide the field(s) you want to update."
}

uip 评估计划暂停

暂停活动计划 — resume 前不再运行触发器。

参数

名称	必填	用途
<schedule-id>	是	计划暂停。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥。
—	--tenant	name	会话默认值	UiPath 租户名称。

示例

uip eval schedule pause b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

数据形状（--输出 json）

{
  "Code": "EvalSchedulePaused",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "paused",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

uip 评估计划继续

恢复已暂停的计划。

参数

名称	必填	用途
<schedule-id>	是	要恢复的计划。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥。
—	--tenant	name	会话默认值	UiPath 租户名称。

示例

uip eval schedule resume b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

数据形状（--输出 json）

{
  "Code": "EvalScheduleResumed",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

uip 评估计划删除

永久删除计划。

参数

名称	必填	用途
<schedule-id>	是	要删除的计划。

选项

短	长	值	默认	描述
—	--process-key	GUID	—	必需。流程密钥。
—	--tenant	name	会话默认值	UiPath 租户名称。

示例

uip eval schedule delete b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

数据形状（--输出 json）

{
  "Code": "EvalScheduleDeleted",
  "Data": { "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001" }
}

相关命令

• uip eval — 概述、 execute-and-evaluate和run 。
• uip eval evaluator — 定义计划的评估集可以使用的评估程序。
• uip eval eval-set / evaluation — 定义计划的实际运行时间。

另请参阅

• uip or概述— 每个uip or动词的共享约定。
• 全局选项
• 退出代码