UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP AOPS 管道

“uip aops 管道”和“uip aops 执行”的语法和选项,用于管理 CICD 管道并检查或控制其运行。

uip aops pipeline 管理 CI/CD 管道 — 列出、获取、创建、更新、运行、删除。uip aops execution 检查并控制一个管道运行 — 获取元数据、流式传输日志、获取作业详细信息或停止作业。两者都会调用 CICD 服务,这是连接/项目页面上来自来源控件命令的单独标识符命名空间。有关共享概念,请参阅uip aops概述。

备注:

pipeline update <id> --file为完全替换(HTTP PUT 语义) ,并且需要EditPipelineDto形状,而不是PipelineDto默认情况下返回的pipeline get 。不要将 pipeline get <id> > p.json 直接通过管道传输到 update --file p.json — 改为使用 pipeline get <id> --for-update --output-file <path>,该操作会写入已转换的形状。

大纲​

uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]
uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]

UIP AOPS 管道列表​

列出在活动的运行时环境中可见的管道(通过“Studio 管理员用户界面”设置 — 如果看不到预期的内容,请在其中切换租户/文件夹)。

选项​

长值描述
--repository-ids <csv>逗号分隔范围缩小到一个或多个 SC 存储库 UUID(来自 connection repos)。
--offset <n>整数要跳过的数量。必须是 --limit 的倍数。默认 0。
--limit <n>整数要返回的最大值。默认 20。
--search <term>字符串管道名称的服务器端子字符串筛选器。

数据形状(--输出 json)​

{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}
{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}

每个管道一个策划行 — 对完整的 DTO 使用 pipeline get <id>,包括分支和项目绑定。

UIP AOPS 管道状态​

获取管道状态的运行时环境快照 — Studio 管理员仪表板使用的计数和汇总状态。一种在列出或变异之前确认运行时环境可以访问的低成本方法。

数据形状(--输出 json)​

{ "Code": "PipelinesState", "Data": {} }
{ "Code": "PipelinesState", "Data": {} }

UIP AOPS 管道流程​

列出可以绑定管道的自动化流程。

数据形状(--输出 json)​

{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}
{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}

每个流程策划的行 — 在编写管道时,将返回的 ProcessId 用作 PipelineDto 的 processIdentifier。使用 pipeline process <process-id> 深入分析,以获取包括参数的完整 DTO。

UIP AOPS 管道流程​

通过标识符解析单个自动化流程。

参数​

名称必填用途
<process-id>是来自 pipeline processes 的流程标识符。

数据形状(--输出 json)​

{ "Code": "PipelineProcess", "Data": {} }
{ "Code": "PipelineProcess", "Data": {} }

uip aops 管道存储库​

列出至少具有一个管道的来源控件存储库。

数据形状(--输出 json)​

{ "Code": "PipelineRepos", "Data": [] }
{ "Code": "PipelineRepos", "Data": [] }

uip aops 管道获取​

按标识符获取管道。

参数​

名称必填用途
<pipeline-id>是来自 pipeline list 的管道标识符。

选项​

长值描述
--for-update标记返回 EditPipelineDto 形状而不是完整的 PipelineDto,并移除仅服务器字段 — 将结果直接输入 pipeline update --file,无需手动转换。
--output-file <path>路径同时将有效负载以 JSON(UTF-8,缩进 2 个空格)的形式写入此文件。标准输出仍会发出完整的结构化信封。

--for-update 以 Data(非帕斯卡拼写法)保留 DTO 自己的密钥大小写。--output-filter 根据打印的 Data 运行,区分大小写 — 使用 --for-update 时,可与 DTO 自己的字段名称匹配。

示例​

uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json
uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json

数据形状(--输出 json)​

{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }
{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }

按名称查找管道。

选项​

长值描述
--name <name>字符串精确匹配查找。返回单个 PipelineDto。
--prefix <prefix>字符串“开头为查询”。返回一个数组。

--name/--prefix 中仅需要其中一个 — 同时传递两者,或两者均不失败,在任何网络调用之前客户端均会失败。

示例​

uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"
uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"

数据形状(--输出 json)​

{ "Code": "PipelineSearch", "Data": {} }
{ "Code": "PipelineSearch", "Data": {} }

没有匹配失败与 Pipeline '<name>' not found.(对于 --name)或 No pipelines matched prefix '<prefix>'.(对于 --prefix),而不是空的成功。

uip aops 管道创建​

从符合 PipelineDto 的 JSON 文件创建新管道。

选项​

长值必填描述
--file <path>路径是JSON 文件,其中包含要创建的 PipelineDto。不要包含服务器分配的 identifier。
--telemetry-flow-id <id>字符串否服务器端关联的遥测流程 ID。

数据形状(--输出 json)​

{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }

捕获返回的 identifier,以用于后续的 run/update/delete 调用。冲突错误通常意味着已经存在具有相同名称的管道。

uip aops 管道更新​

更新现有管道。完全替换 (HTTP PUT) — 在服务器端清除文件省略的任何字段。

参数​

名称必填用途
<pipeline-id>是要更新的管道。如果设置了文件的 identifier,则该字段必须匹配该字段。

选项​

长值必填描述
--file <path>路径是包含要应用的 EditPipelineDto 的 JSON 文件。

仅发送 EditPipelineDto 自己的密钥 — 带有无法识别密钥的文件(包括仅大小写错误的文件)会被直接拒绝,而不是作为部分擦除静默丢弃。

数据形状(--输出 json)​

{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }
{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }

Data.Pipeline 回显已发送的请求,而不是从磁盘读取的文件。

UIP AOPS 管道删除​

按标识符删除管道。永久 — 正在运行的执行不会自动停止,但新的运行会立即拒绝。

参数​

名称必填用途
<pipeline-id>是来自 pipeline list 的管道标识符。

选项​

长描述
-y, --yes必需。确认此不可撤销的操作。

数据形状(--输出 json)​

{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

UIP AOPS 管道运行​

触发管道运行。立即返回 202 — 运行已异步排队。

参数​

名称必填用途
<pipeline-id>是来自 pipeline list 的管道标识符。

数据形状(--输出 json)​

{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

使用 pipeline executions <pipeline-id> 发现新的执行 ID,然后使用 execution logs --follow 进行跟踪。

uip aops 管道“保存并运行”​

根据 JSON 保留管道 DTO 并立即运行。

选项​

长值必填描述
--file <path>路径是包含要保存和运行的 PipelineDto 的 JSON 文件。
--telemetry-flow-id <id>字符串否服务器端关联的遥测流程 ID。

数据形状(--输出 json)​

{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}
{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}

executionId 已从持久性管道的 latestPipelineExecution 中提升,以立即链接到 execution logs --follow 中;如果缺少该字段,则为 null。

uip aops 管道执行​

列出管道的执行。

参数​

名称必填用途
<pipeline-id>是来自 pipeline list 的管道标识符。

选项​

长值描述
--offset <n>整数要跳过的数量。必须是 --limit 的倍数。默认 0。
--limit <n>整数要返回的最大值。默认 20。

数据形状(--输出 json)​

{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}
{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}

针对完整 DTO(运行模式,触发用户,jobExecutionIdentifier,失败代码)使用 execution get <execution-id> 深入钻取。

uip aops 管道执行(批量)​

在一个来回中获取多个管道执行的元数据。

选项​

长值必填描述
--ids <csv>逗号分隔是管道执行标识符(来自pipeline executions )— 而非管道 ID。

数据形状(--输出 json)​

{ "Code": "PipelineExecutionsBulk", "Data": [] }
{ "Code": "PipelineExecutionsBulk", "Data": [] }

uip aops 执行​

检查并控制管道执行。除 get 外的所有动词均接受 <execution-id> 位置词(CLI 为您查找基础 jobKey)或 --job-key <key> 以跳过该查找(在已经拥有该查找项时)。get 仅由执行 ID 设置键控。

UIP AOPS 执行获取​

按执行 ID 获取管道执行的元数据。

参数​
名称必填用途
<execution-id>是发件人为 pipeline executions <pipeline-id>。
选项​
长描述
--with-arguments同时获取管道运行时使用的 runtime 输入参数(已解析的 JSON,如果解析失败,则为原始字符串)。增加一次往返时间。
数据形状(--输出 json)​
{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }
{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }

将返回的jobExecutionIdentifier 用作--job-key logs/details / 的stop ,以跳过其自动查找。

uip aops 执行日志​

获取执行日志。

参数​
名称必填用途
[execution-id]有条件地除非设置了 --job-key,否则为必填项;无论是否设置了 --follow,都为必要项(状态轮询以执行 ID 为关键字)。
选项​
长值描述
--job-key <key>字符串直接使用此作业密钥,跳过执行 ID 查找操作。
--follow标记以流式传输的方式记录日志,直到执行达到终止状态 (Successful/Faulted/Stopped)。
--limit <n>整数每次日志提取的页面大小。默认 200。
--poll-interval <ms>整数设置 --follow 时的轮询间隔。默认 2000。
--timeout <ms>整数放弃之前要遵循的最长时间。默认 1800000(30 分钟)。

不使用 --follow:打印当前日志切片并退出 (Code: "ExecutionLogs")。使用--follow :日志行在到达时流式传输到标准错误(不受--log-level影响,不会被--log-file捕获 — 显式重定向标准错误以保留它们),标准输出发出最终信封,其中包含最终状态和行计数( Code: "ExecutionLogsFollowed" )。

示例​
uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log
uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log
数据形状(--输出 json)​
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }

UIP AOPS 执行详细信息​

获取基础作业执行详细信息文档 — 机器人、计算机、版本和主机上下文。当对故障进行分类以查看其在哪个运行器上运行时,此方法非常有用。

参数​
名称必填用途
[execution-id]有条件地除非设置了 --job-key,否则为必填项。
选项​
长值描述
--job-key <key>字符串直接使用此作业密钥,跳过执行 ID 查找操作。
数据形状(--输出 json)​
{ "Code": "ExecutionDetails", "Data": {} }
{ "Code": "ExecutionDetails", "Data": {} }

uip aops 执行停止​

请求停止管道执行。幂等— 在已经终止的执行上调用它,可返回当前状态,而不会出错。

参数​
名称必填用途
[execution-id]有条件地除非设置了 --job-key,否则为必填项;必需,无论是否设置了 --wait。
选项​
长值描述
--job-key <key>字符串直接使用此作业密钥,跳过执行 ID 查找操作。
--wait标记轮询直到执行到达终端,而不是立即返回。
--poll-interval <ms>整数设置 --wait 时的轮询间隔。默认 2000。
--timeout <ms>整数设置 --wait 时的最长时间等待时间。默认 300000(5 分钟)。
示例​
uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait
uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait
数据形状(--输出 json)​
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }

使用 --wait,最终信封为 Code: "ExecutionStopped" 且 state 已结算。对已终止的执行调用 stop 将返回 Code: "ExecutionAlreadyTerminal",而不是重新发出停止。

  • uip aops — 概述和概念。
  • connections — 发现管道构建基于的存储库。
  • projects — 发现管道绑定到的流程。

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新