uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UIP Platform 租户
“uip platform 租户”的语法和选项,可读取并更新每个租户的许可证分配。
uip platform tenants 读取和更新每个租户的许可证分配,并管理每个文件夹的结果计费配置。licenses get 返回租户的有效产品分配(已分配、可用、已消耗、有效期窗口); licenses set 覆盖 {code, quantity} 条目的 JSON 增量,将每个产品代码路由到已在租户中拥有该代码的服务许可证。folder-outcome-billing get/set 读取租户中的特定文件夹,并切换其是否启用了结果计费。
大纲
uip platform tenants licenses <verb> [options] <tenant-key>
uip platform tenants folder-outcome-billing <verb> [options] <tenant-id> <folder-key>
uip platform tenants licenses <verb> [options] <tenant-key>
uip platform tenants folder-outcome-billing <verb> [options] <tenant-id> <folder-key>
动词
| 组 | 动词 | 用途 |
|---|---|---|
licenses | get | 获取租户有效的许可证摘要(每个产品一行,日期为 ISO 格式)。 |
licenses | set | 将{code, quantity}条目的增量应用于租户的 runtime 许可证和消耗品,并在服务类型之间自动路由。 |
folder-outcome-billing | get | 获取租户中文件夹的结果计费配置。 |
folder-outcome-billing | set | 为租户中的文件夹启用或禁用结果计费。 |
UIP Platform 租户许可证的获取
获取租户的许可证摘要:每个产品代码的分配数量、可用数量、消耗数量,以及友好名称。每个活动产品返回一行(消耗品和 runtime 许可证均适用)。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<tenant-key> | 是 | 租户密钥 (GUID)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform tenants licenses get 296b7134-6691-43db-b48a-2d95ed3ab031
uip platform tenants licenses get 296b7134-6691-43db-b48a-2d95ed3ab031
数据形状(--输出 json)
{
"Code": "TenantLicenses",
"Data": [
{
"code": "PLTU",
"name": "Platform Units",
"allocated": 300,
"availableForAllocation": 4700,
"allocatedAcrossOtherTenants": 0,
"totalUnitsInAccount": 5000,
"consumed": 50,
"startDate": "2023-11-14T22:13:20.000Z",
"endDate": "2027-09-15T18:40:00.000Z"
}
]
}
{
"Code": "TenantLicenses",
"Data": [
{
"code": "PLTU",
"name": "Platform Units",
"allocated": 300,
"availableForAllocation": 4700,
"allocatedAcrossOtherTenants": 0,
"totalUnitsInAccount": 5000,
"consumed": 50,
"startDate": "2023-11-14T22:13:20.000Z",
"endDate": "2027-09-15T18:40:00.000Z"
}
]
}
UIP Platform 租户许可证已设置
为租户设置 runtime 许可证和消耗品。CLI 获取租户的现有服务许可证,通过code为其产品建立索引,并将每个输入条目路由到已经拥有该代码的服务许可证。--input中的数量覆盖当前按代码分配的数量;未列出的产品将保留其现有数量。
如果使用任何输入代码,则该命令在写入之前失败:
- 不在租户的任何现有服务许可证(未路由)中,或
- 显示在多个租户的服务许可证下(模糊路由)。
如果部分失败(一种服务类型在另一种服务类型已成功更新后失败),错误消息将列出已应用的服务类型,以便您可以使用相同输入以幂等方式重新运行。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<tenant-key> | 是 | 租户密钥 (GUID)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--input | 路径 | 必填 | 包含产品增量的 JSON 文件的路径,例如[{"code":"UNATT","quantity":5}] 。数量会按产品代码覆盖当前分配额。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform tenants licenses set 296b7134-6691-43db-b48a-2d95ed3ab031 \
--input ./delta.json
uip platform tenants licenses set 296b7134-6691-43db-b48a-2d95ed3ab031 \
--input ./delta.json
delta.json:
[
{ "code": "PLTU", "quantity": 500 },
{ "code": "RU", "quantity": 100 }
]
[
{ "code": "PLTU", "quantity": 500 },
{ "code": "RU", "quantity": 100 }
]
数据形状(--输出 json)
{
"Code": "TenantLicensesSet",
"Data": [
{
"serviceType": "orchestrator",
"code": "PLTU",
"name": "Platform Units",
"quantity": 500
},
{
"serviceType": "orchestrator",
"code": "RU",
"name": "Robot Units",
"quantity": 100
}
]
}
{
"Code": "TenantLicensesSet",
"Data": [
{
"serviceType": "orchestrator",
"code": "PLTU",
"name": "Platform Units",
"quantity": 500
},
{
"serviceType": "orchestrator",
"code": "RU",
"name": "Robot Units",
"quantity": 100
}
]
}
UIP Platform 租户文件夹结果计费
查看和管理租户文件夹的结果计费配置。
UIP Platform 租户文件夹-结果-账单获取
获取文件夹的结果计费配置:是否启用结果计费。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<tenant-id> | 是 | 租户 ID (GUID)。 |
<folder-key> | 是 | 文件夹密钥 (GUID)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform tenants folder-outcome-billing get 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111
uip platform tenants folder-outcome-billing get 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111
数据形状(--输出 json)
{
"Code": "TenantFolderOutcomeBilling",
"Data": {
"FolderKey": "11111111-1111-1111-1111-111111111111",
"IsOutcomeBillingEnabled": true
}
}
{
"Code": "TenantFolderOutcomeBilling",
"Data": {
"FolderKey": "11111111-1111-1111-1111-111111111111",
"IsOutcomeBillingEnabled": true
}
}
UIP Platform 租户文件夹-结果-计费集
启用或禁用文件夹的结果计费。返回现已生效的配置。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<tenant-id> | 是 | 租户 ID (GUID)。 |
<folder-key> | 是 | 文件夹密钥 (GUID)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--enabled | true | false | 必填 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled true
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled false
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled true
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled false
数据形状(--输出 json)
{
"Code": "TenantFolderOutcomeBillingSet",
"Data": {
"FolderKey": "11111111-1111-1111-1111-111111111111",
"IsOutcomeBillingEnabled": true
}
}
{
"Code": "TenantFolderOutcomeBillingSet",
"Data": {
"FolderKey": "11111111-1111-1111-1111-111111111111",
"IsOutcomeBillingEnabled": true
}
}
退出代码
请参阅退出代码。没有动词特定的覆盖。
相关命令
uip platform licenses consumables— 组织级别的消耗性报告(每个租户的池使用情况、每日细分和文件夹细分)。uip platform users— 按用户的许可证捆绑包。uip or licenses— Orchestrator 级别的计算机和 Named-User 许可证分配。