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

UiPath CLI 用户指南

UIP 解决方案部署

uip solution deploy采用已发布的解决方案包(查看uip solution publish )并将其安装到 Orchestrator 中:创建文件夹,配置资源(队列、资产、流程、存储桶、连接),并激活部署。

本页涵盖deploy下的每个子命令,以及管理 Studio Web 解决方案(而非部署)的顶层uip solution delete

子命令用途
run将已发布的包部署到 Orchestrator。
status检查管道部署的状态。
list列出现有部署。
activate激活未自动激活功能安装的部署。
uninstall删除部署及其配置的资源。
config get获取包的默认部署配置。
config set在部署配置文件中设置资源属性。
config link将解决方案资源链接到现有的 Orchestrator 资源。
config unlink从部署配置文件中删除资源链接。

此页面上还记录了:

  • uip solution delete — 一个顶级谓词,用于按 ID 从 Studio Web 中删除解决方案。它不是部署子命令;出于分组原因,它与这些命令一起记录。

每个子命令都经过身份验证。先运行uip login ,或传递--tenant以特定租户。

典型工作流

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)
deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)

uip 解决方案部署运行

将已发布的解决方案包部署到 Orchestrator。创建新文件夹(在--folder-path--folder-key下),配置包(或--config-file )中描述的所有资源,并轮询,直到部署达到最终状态。

大纲

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]
uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

选项

  • -n, --name <deployment-name> (必填) — 部署的名称。由deploy statusactivateuninstall用于标识此安装。
  • --package-name <name> (必填) — 解决方案包名称。使用packages list查找可用名称。
  • --package-version <version> (必填) — 解决方案包版本。使用packages list查找可用版本。
  • --folder-name <name> (必填) — 为此部署创建的新 Orchestrator 文件夹(在--folder-path下)的名称。
  • --folder-path <path> — 父文件夹路径(例如Shared )。系统将在其下创建部署文件夹。
  • --folder-key <key> — 父文件夹密钥 (GUID)。--folder-path的替代方案。
  • --config-file <path> — JSON 配置文件。使用deploy config get生成变量,使用config set / config link进行编辑,然后在此处传递。
  • -t, --tenant <tenant-name> — 要部署的租户。
  • --timeout <seconds> — 部署轮询超时。默认为360
  • --poll-interval <ms> — 状态轮询之间的毫秒数。默认为5000
  • --login-validity <minutes> — 令牌过期前触发刷新的最短分钟数。默认为10

示例

常见
uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"
uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"
使用自定义配置
uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json
uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json
脚本编写 — 捕获部署 ID 以供后续调用
PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"
PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

数据形状(--输出 json)

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}
{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}

终端部署状态: DeploymentSucceededDeploymentFailedValidationFailedConflictFixingErrorDeploymentScheduleError 。不成功的最终状态以1退出,并将验证/冲突/计划/工作流错误聚合到Instructions字段中。

超时行为

如果部署在--timeout过去之前未达到终止状态,则命令将非零退出,并将指针指向deploy status <pipeline-deployment-id> ,以便您继续监控。


UIP 解决方案部署状态

查看管道部署的当前状态。返回部署状态;如果可用,还返回部署的名称/包/版本以及级联的错误摘要。

参数

  • <pipeline-deployment-id> (必需)PipelineDeploymentId返回的deploy run

选项

  • -t, --tenant <tenant-name> — 要查询的租户。
  • --login-validity <minutes> — 默认为10

示例

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

数据形状(--输出 json)

{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}
{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}

UIP 解决方案部署列表

列出解决方案部署。显示部署名称、状态、包版本和文件夹路径。

选项

  • -t, --tenant <tenant-name> — 要查询的租户。
  • --folder-path <path> — 按父文件夹路径筛选。提取应用筛选;如果使用此筛选条件时结果看起来不完整,则增加--take
  • --folder-key <key> — 按父文件夹密钥 (GUID) 筛选。--folder-path的替代方案。
  • --take <number> — 要获取的最大部署数量。默认为10
  • --order-by <column> — 要排序的列。默认为startTime
  • --order-direction <direction>AscendingDescending 。默认值为Descending
  • --login-validity <minutes> — 默认为10

示例

uip solution deploy list --take 20 --folder-path "Shared/Production"
uip solution deploy list --take 20 --folder-path "Shared/Production"

数据形状(--输出 json)

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}
{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}

uip 解决方案部署激活

激活未自动激活功能安装的部署。激活会配置所有解决方案组件。activate首先打印 Orchestrator 报告的预激活步骤(通过--log-level info报告给 STDERR),然后调用激活并轮询,直到达到最终状态( SuccessfulActivateFailedActivate )。

参数

  • <deployment-name> (必填) — 要激活的部署的名称。使用deploy list查找部署名称。

选项

  • -t, --tenant <tenant-name> — 要目标的租户。
  • --timeout <seconds> — 激活轮询超时。默认为360
  • --poll-interval <ms> — 状态轮询之间的毫秒数。默认为5000
  • --login-validity <minutes> — 默认为10

示例

uip solution deploy activate my-deployment
uip solution deploy activate my-deployment

数据形状(--输出 json)

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

如果 Orchestrator 报告无instanceId (没有可轮询的内容),则StatusActivation completed (no instance to poll) ,并且命令成功返回。


UIP 解决方案部署卸载

卸载已部署的解决方案。删除所有已配置的资源和解决方案文件夹。

参数

  • <deployment-name> (必填) — 要卸载的部署的名称。

选项

  • -t, --tenant <tenant-name> — 要目标的租户。
  • --timeout <seconds> — 卸载轮询超时。默认为360
  • --poll-interval <ms> — 状态轮询之间的毫秒数。默认为5000
  • --login-validity <minutes> — 默认为10

示例

uip solution deploy uninstall my-deployment
uip solution deploy uninstall my-deployment

数据形状(--输出 json)

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

可能的两种短期响应:

  • Uninstall completed immediately — 当 Orchestrator 在首次调用时报告complete: true时;不会进行轮询。
  • Uninstall scheduled — 当 Orchestrator 在不返回实例 ID 的情况下计划工作时;数据包含 API 中的Scheduled字段。

uip 解决方案部署配置获取

获取已发布的解决方案包的默认部署配置。该配置列出了解决方案将创建的每个资源(队列、资产、流程、存储桶、连接等)及其默认设置。将其保存到文件 ( -d ),使用config set / config link进行自定义,然后将其传递给deploy run --config-file

参数

  • <package-name> (必填) — 解决方案包名称。使用packages list

选项

  • --package-version <version> — 包版本。如果省略,则使用最新版本。
  • -d, --destination <path> — 将配置写入此文件而不是标准输出。
  • -t, --tenant <tenant-name> — 要查询的租户。
  • --login-validity <minutes> — 默认为10

示例

uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json
uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

数据形状(--输出 json)

当提供-d时:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}
{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}

省略-d时,系统会将配置嵌入到响应中:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}
{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}

UIP 解决方案部署配置集

在部署配置文件中编辑资源属性。在您将文件传递给deploy run --config-file之前,文件将保持在本地状态。

参数

  • <file> (必填) — 部署配置 JSON 文件的路径(由config get生成)。
  • <args...> (必需) — 取决于--all
    • 没有--all : <resource> <property> <value> — 例如MyQueue maxNumberOfRetries 5
    • 使用--all : <property> <value> — 适用于文件中的每个资源。仅对顶层conflictFixingAction属性有效。

选项

  • --all — 将属性应用于文件中的所有资源。仅允许与conflictFixingAction一起使用(例如UseExisting )。

示例

更改单个队列的重试次数
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
为每个资源设置冲突修复策略
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

数据形状(--输出 json)

单个资源更新:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}
{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

批量更新 ( --all ):

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}
{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

将解决方案资源链接到现有Orchestrator 资源,以便部署重用该资源,而不是创建新资源。更改为本地更改 — 通过将文件传递给deploy run --config-file来应用更改。

参数

  • <file> (必填) — 部署配置 JSON 文件的路径。
  • <resource> (必填) — 资源名称或配置文件中的resourceKey

选项

  • -n, --name <name> (必填) — 要链接到的现有 Orchestrator 资源的名称。
  • --folder-path <path> — 现有资源所在的 Orchestrator 文件夹路径。

示例

uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"
uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"

数据形状(--输出 json)

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}
{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

删除先前使用config link设置的链接。在下一个deploy run --config-file ,系统将全新创建资源,而不是重用。

参数

  • <file> (必填) — 部署配置 JSON 文件的路径。
  • <resource> (必填) — 资源名称或要取消链接的resourceKey

示例

uip solution deploy config unlink ./deploy-config.json MyQueue
uip solution deploy config unlink ./deploy-config.json MyQueue

数据形状(--输出 json)

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}
{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}

故障模式

  • 资源当前未链接。该命令会拒绝取消链接,并指向config link

UIP 解决方案删除

uip solution delete是顶级谓词(而非deploy子命令),用于通过解决方案 ID 从Studio Web中删除解决方案。ID 在其输出中由uip solution uploadflow debug发出。

不会从 Orchestrator 卸载已部署的解决方案 — 为此,请使用deploy uninstall

大纲

uip solution delete <solution-id>
uip solution delete <solution-id>

参数

  • <solution-id> (必填) — Studio Web 解决方案 ID (UUID)。

示例

uip solution delete a1b2c3d4-0000-0000-0000-000000000001
uip solution delete a1b2c3d4-0000-0000-0000-000000000001

数据形状(--输出 json)

{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

另请参阅

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新