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

获取租户机器人分配

GET 端点,用于检索分配给特定租户和正在使用的机器人运行时数量。

检索分配给特定租户的 Unattended Robot 运行时数量,并检索当前正在使用的数量(可用)。每次调用时,都会从 Orchestrator 中实时读取使用中计数。需要以下之一:

  • 具有 PM.License.Read(或 PM.License)作用域的外部应用程序。了解如何创建外部应用程序。
  • 组织管理员用户令牌。
  • 内部服务到服务令牌。

API 端点​

GET {accessURL}/{organizationName}/license_/api/account/{accountId}/tenant/{tenantId}/robots

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL:

Cloud Platform访问 URL
Automation Cloudhttps://cloud.uipath.com/
Automation Cloud 公共部门https://govcloud.uipath.us/
Automation Cloud 专用https://{customURL}.dedicated.uipath.com/
备注:

{organizationName} 和 {accountId} 都标识同一个组织:{organizationName} 是 URL 路由前缀中的组织名称,而 {accountId} 是用作路径参数的组织 ID (GUID)。与任何标准 URL 中一样,路由前缀也接受组织 ID。

请求标头​

--header 'Authorization: Bearer {access_token}'
--header 'Authorization: Bearer {access_token}'
备注:

要获取外部应用程序的{access_token} ,请使用客户端授予的凭据进行身份验证,如身份验证方法页面中所述。

路径参数​

路径参数数据类型描述
accountId (必填)Guid租户所在的组织的 ID。
tenantId (必填)Guid要为其检索机器人分配的租户 ID。

响应​

200 OK​

返回指定租户的机器人分配情况。

  • serviceScopeId:请求中的租户 ID。
  • serviceType:始终为 orchestrator。
  • usageAvailable:如果从 Orchestrator 检索了使用中计数,则为 true。无法访问 Orchestrator 时为false;在这种情况下,系统会省略 inUse 中的每个条目中的 robots,以便永远不会将不可用的使用量报告为零。
  • robots:对于分配给租户的每种 Unattended Robot 类型,指定已分配的数量 (allocated) 以及当前正在使用的数量 (inUse) 和可用数量。仅列出分配给租户的产品。有关可用代码,请参阅机器人。

当租户没有 Orchestrator 服务许可证或未分配 Unattended Robot 许可证时,robots 以空数组形式返回,且 usageAvailable 将 false 设置为 。在这种情况下,不会对 Orchestrator 进行任何调用。

备注:

此端点仅涵盖 Unattended Robot runtime(UNATT、NONPR、UNATT-HOSTING、TAUNATT、APPTESTR)。不包括有人值守许可证和其他命名用户许可证,因为这些是用户许可证,而不是运行时许可证。它还会每次调用返回一个租户的分配额:要检索组织中每个租户的机器人分配额,请为每个租户调用一次端点。

请求示例​

请求应类似于以下示例 (cURL):

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/license_/api/account/11111111-1111-1111-1111-111111111111/tenant/22222222-2222-2222-2222-222222222222/robots' \
--header 'Authorization: Bearer {access_token}'
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/license_/api/account/11111111-1111-1111-1111-111111111111/tenant/22222222-2222-2222-2222-222222222222/robots' \
--header 'Authorization: Bearer {access_token}'

以下是成功检索机器人分配后的响应正文:

{
  "serviceScopeId": "22222222-2222-2222-2222-222222222222",
  "serviceType": "orchestrator",
  "usageAvailable": true,
  "robots": [
    { "code": "UNATT", "allocated": 10, "inUse": 3 },
    { "code": "NONPR", "allocated": 2, "inUse": 0 }
  ]
}
{
  "serviceScopeId": "22222222-2222-2222-2222-222222222222",
  "serviceType": "orchestrator",
  "usageAvailable": true,
  "robots": [
    { "code": "UNATT", "allocated": 10, "inUse": 3 },
    { "code": "NONPR", "allocated": 2, "inUse": 0 }
  ]
}
  • API 端点​
  • 请求标头​
  • 路径参数​
  • 响应​
  • 200 OK​
  • 请求示例​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新