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

UiPath CLI 用户指南

UIP 资源

uip resource管理自动化在运行时依赖的 Orchestrator 资源,其中包括资产、存储桶和存储桶文件、库、队列和队列项目、触发器以及 Webhook。它是这些实体的通用 CRUD 界面,独立于uip solution resource (检查本地解决方案资源声明)和uip or (Orchestrator 自动化工具,用于作业、流程、文件夹等)。

备注:

工具别名为resource (单数),而不是resources 。每个示例都使用uip resource <kind>

uip resource@uipath/resource-tool插件提供。如果尚未安装, uip tools install resource会进行添加。请参阅工具(插件)

资源

每个资源都有其自己的参考页面。每个页面上设置的动词与uip resource注册的命令匹配 — 运行uip resource --help以确认安装的完整表面。

资源用途
资产自动化在运行时使用的命名配置值(Text、Bool、Integer、Credential、Secret)。文件夹范围。
存储桶自动化使用的文件的存储容器。文件夹范围。
存储桶文件存储桶中的单个文件。列出、上传、下载、删除和获取预签名 URL。
可重用.nupkg包(共享活动和逻辑)。租户范围。
队列事务工作项目的容器。文件夹范围。
队列项目队列内的单个事务,具有完整的状态机控件。文件夹范围。
触发器用于启动作业的时间、队列和 API 触发器。时间/队列触发器是文件夹作用域; API 触发器在租户范围内。
Webhooks在平台事件(作业完成、队列项目失败等)上触发的 HTTP 回调。租户范围。

大纲

uip resource <resource> <verb> [options]
uip resource <resource> <verb> [options]

默认输出为JSON 。每个子命令都遵循全局选项--output--output-filter--log-level--log-file ),并返回标准退出代码

约定

  • 身份验证。每个uip resource子命令都会调用 Orchestrator。先运行uip login ,或在任何子命令上传递-t, --tenant <tenant-name> ,以针对经过身份验证的组织中的特定租户。
  • 文件夹作用域。资产、存储桶、队列、队列项目和触发器(时间/队列)位于文件夹范围内。提供--folder-path <path> 例如对"Shared"--folder-key <guid>及相关调用执行listcreategetupdatedelete在可行的情况下通过键值解析跨文件夹 — 资源页面上的每个动词说明会明确指出。库、API 触发器和 Webhook 是租户范围内的,并且不接受--folder-*
  • 键。大多数资源由list输出中返回的 GUID 标识(在keyidentifier下返回,或者在uniqueKeykey下重试链)。数字id字段是内部字段,不应传递给命令。
  • 分页。列表动词接受-l, --limit <n>--offset <n>--order-by <field> (OData 语法,例如"Name asc" )。存储桶文件list是一个异常,它使用continuationToken
  • 筛选。在支持的情况下, -n, --name <name>是资源名称的包含匹配项;部分资源添加--enabled--disabled--status等。

数据形状

成功的输出始终遵循标准信封:

{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}
{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}

每个动词的Code记录在资源页面( AssetListAssetCreatedBucketFileQueueItemAddedTriggerEnabledWebhookPinged等)中。Data是单个对象( getcreateupdate )或数组( listversionsevent-typeshistory )。

列表当前已展开— 不包含顶层countnextPage字段。存储桶文件list为例外;其有效负载包含用于分页的continuationToken

工作示例

列出文件夹中的队列

uip resource queues list --folder-path Shared
uip resource queues list --folder-path Shared

创建资产,然后在文件夹之间共享该资产

uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production
uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production

从 JSON 文件批量添加队列项目

ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json
ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json
  • uip solution deploy config link — 将解决方案已声明的资源绑定到通过uip resource创建的资产/队列/存储桶之一。
  • uip solution resource list — 检查本地解决方案中的资源声明。
  • uip or — 用于文件夹、流程、版本、作业、计算机、用户和凭据存储,您在使用uip resource时通常需要从中查找密钥。

另请参阅

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新