uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UIP ah
使用“uip ah”工具管理 Automation Hub 自动化概念、管道、分类、市场和用户。
uip ah 是 Automation Hub 工具(命令前缀 ah,包 @uipath/automation-hub-tool):它管理自动化概念管道(通过评估提交、进入可配置阶段、评分并跟踪到交付)以及分类、协作以及围绕其的 Marketplace 界面。使用 uip tools install ah 安装,或调用 uip ah … 并运行自动安装。请参阅工具(插件) ,了解安装模式。
概念
- 每次写入都是完整记录替换,而不是补丁。
automations update、categories update、users update和tags set都会发送 Automation Hub 的完整记录形状 — 未传递的字段从已存储的字段中转移(或者,对于categories update/tags set,整个集合将被完全替换)。准确检查每个动词自己的注释,了解保留的内容和覆盖的内容。 --all-fields用于每个读取命令。一个原始 Automation Hub 记录包含大约 300 个键,包括用于大多数键的__display预格式化映射键。默认情况下,每个list/get命令都会缩小为可管理字段集;对于未受影响的有效负载,传递--all-fields。- 已分页与未分页的端点。大多数
list命令都会触发分页的 Automation Hub 端点,并正常接受--limit/--offset。少数端点(roles、idea-flows、questionnaires list、audit-logs list、collaborators list)在一次调用中返回整个集合,没有服务器端分页 —--limit/--offset在客户端应用获取完整集后,再显示。 - ID 来自其他
list命令,而不来自用户界面。Automation Hub 的网页用户界面不会公开此 CLI 使用的大多数数字 ID(类别 ID、阶段状态 ID、角色 ID)。请使用相应的list --all-fields命令来查找这些 ID,正如每个动词自己的错误消息所指出的那样。 - 此工具特定错误:403 表示“对您的 Automation Hub 角色不可见”,从未“未找到”— Automation Hub 不会对范围外的记录使用 404。500 类“此租户上未配置 Automation Hub”。或“尚没有自己的租户记录”;响应显示为
Result: "ConfigError",并包含租户入门说明,这与身份验证失败不同。
资源
每个资源都有其自己的参考页面。每个页面上设置的动词与uip ah注册的命令匹配 — 运行uip ah --help以确认安装的完整表面。
| 资源 | 用途 |
|---|---|
| 自动化、概念流程、业务用例、阶段、问卷调查、管道 | 核心概念到交付的生命周期:提交和读取自动化概念,发现阶段/状态转换,读取成本收益分析,在各个阶段移动概念,读取评估问题目录,并读取收益排名的管道视图。 |
| 应用程序、组件、文档、媒体、商店列表、商店评论 | 标记了应用程序清单自动化,其中包括可重用组件、附加文档和媒体以及 Automation Store 市场(已发布的列表及其评论)。 |
| 类别、标签、协作者、角色、用户 | 类别分类、自由文本标签、每个自动化的协作者及其角色、可分配的角色目录和 Automation Hub 用户帐户。 |
audit-logs, auth-info | 在本页下方介绍 — 小型的横向实用程序资源。 |
uip ah 审核日志
阅读 Automation Hub 审核追踪。Automation Hub 按周将跟踪分组为 CSV 捆绑包,而不是平面日志。
uip ah 审核日志列表
列出一个日期范围内的审核日志捆绑包。
选项
| 长 | 值 | 描述 |
|---|---|---|
--start-date <date> | YYYY-MM-DD | 范围起点。 |
--end-date <date> | YYYY-MM-DD | 范围端点。 |
--limit <n> | 整数 | 要返回的最大捆绑包数量。默认 20。 |
--offset <n> | 整数 | 要跳过的捆绑包数量。默认 0。 |
--all-fields | 标记 | 返回原始有效负载,而不是预计的 Name/EntryCount 字段。 |
未分页端点 — 获取日期范围内的整个集合,然后在客户端窗口化。空历史记录(404 “未找到审核日志”)将折叠到空 Data 数组中,而不是作为错误显示。
示例
uip ah audit-logs list --start-date 2026-07-01 --end-date 2026-08-04
uip ah audit-logs list --start-date 2026-07-01 --end-date 2026-08-04
数据形状(--输出 json)
{
"Code": "AhAuditLogsList",
"Data": [
{ "Name": "tenant-service-audit-log-(2026-08-02)-to-(2026-08-08).csv", "EntryCount": 12 }
]
}
{
"Code": "AhAuditLogsList",
"Data": [
{ "Name": "tenant-service-audit-log-(2026-08-02)-to-(2026-08-08).csv", "EntryCount": 12 }
]
}
由对象引用 Blob 而不是内联条目支持的捆绑包返回 Uri(download --uri 值接受)而不是 EntryCount。
uip ah 审核日志下载
将一个审核日志捆绑包另存为本地 CSV 文件。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--uri <name> | 字符串 | 是 | 捆绑包名称,与 Name 中的 audit-logs list 字段完全相同。 |
--destination <path> | 路径 | 是 | 要写入 CSV 的本地路径。 |
示例
uip ah audit-logs download --uri <name> --destination ./audit.csv
uip ah audit-logs download --uri <name> --destination ./audit.csv
数据形状(--输出 json)
{ "Code": "AhAuditLogsDownload", "Data": { "Destination": "./audit.csv", "Bytes": 4096, "Rows": 20 } }
{ "Code": "AhAuditLogsDownload", "Data": { "Destination": "./audit.csv", "Bytes": 4096, "Rows": 20 } }
uip ah 身份验证信息
单一质量名称资源 — 每个会话只有一个身份,因此没有任何内容可列出。
获取 uip ah 身份验证信息
显示 Automation Hub 租户以及您在其中的身份 — 检查是否为活动租户启用并加入 Automation Hub 的最快时间。
选项
| 长 | 描述 |
|---|---|
--all-fields | 返回原始有效负载,而不是汇总的 Type/Tenant/User 字段。 |
示例
uip ah auth-info get
uip ah auth-info get
数据形状(--输出 json)
{
"Code": "AhAuthInfoGet",
"Data": {
"Type": "automation-cloud",
"Tenant": { "Uuid": "...", "CompanyName": "acme - finance", "Url": "..." },
"User": {
"Id": 3, "Email": "jane@acme.com", "FirstName": "Jane", "LastName": "Doe",
"JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA",
"IsAdmin": 1, "IsActive": 1, "Roles": ["ah-system-admin"]
}
}
}
{
"Code": "AhAuthInfoGet",
"Data": {
"Type": "automation-cloud",
"Tenant": { "Uuid": "...", "CompanyName": "acme - finance", "Url": "..." },
"User": {
"Id": 3, "Email": "jane@acme.com", "FirstName": "Jane", "LastName": "Doe",
"JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA",
"IsAdmin": 1, "IsActive": 1, "Roles": ["ah-system-admin"]
}
}
}
大纲
uip ah audit-logs list [--start-date <date>] [--end-date <date>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah audit-logs download --uri <name> --destination <path>
uip ah auth-info get [--all-fields]
uip ah audit-logs list [--start-date <date>] [--end-date <date>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah audit-logs download --uri <name> --destination <path>
uip ah auth-info get [--all-fields]