UiPath Documentation
automation-cloud
latest
false
Guia de API da UiPath Automation Cloud

Obter alocação de robô de tenant

Ponto de extremidade GET para recuperar o número de runtimes do robô alocados e em uso por um tenant específico.

Recupera o número de runtimes de robôs unattended alocados para um tenant específico e, quando disponíveis, quantos deles estão em uso no momento. A contagem em uso é lida ao vivo do Orchestrator em cada chamada. Requer um dos seguintes:

  • Um aplicativo externo com o escopo PM.License.Read (ou PM.License). Descubra como criar um aplicativo externo.
  • Um token de usuário administrador da organização.
  • Um token de serviço interno.

Ponto de Extremidade da API​

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

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud PlatformURL de acesso
Automation Cloudhttps://cloud.uipath.com/
Automation Cloud Setor públicohttps://govcloud.uipath.us/
Automation Cloud dedicadohttps://{customURL}.dedicated.uipath.com/
Observação:

{organizationName} e {accountId} identificam a mesma organização: {organizationName} é o nome da organização no prefixo de roteamento do URL, enquanto {accountId} é o ID da organização (GUID) usado como um parâmetro de caminho. O ID da organização também é aceito no prefixo de roteamento, como em qualquer URL padrão.

Cabeçalhos de solicitação.​

--header 'Authorization: Bearer <your-access-token>'
--header 'Authorization: Bearer <your-access-token>'
Observação:

Para obter o <your-access-token> para um aplicativo externo, autentique usando a concessão de credenciais do cliente, conforme descrito na página Métodos de autenticação.

Parâmetros do caminho​

Parâmetro do caminhoTipo de dadosDescription
accountId (obrigatório)GuidA ID da organização na qual o tenant reside.
tenantId (obrigatório)GuidO ID do tenant para o qual recuperar a alocação do robô.

Resposta​

200 OK​

Retorna a alocação do robô para o tenant especificado.

  • serviceScopeId: o ID do tenant da solicitação.
  • serviceType: sempre orchestrator.
  • usageAvailable: true quando as contagens em uso foram recuperadas do Orchestrator. false quando o Orchestrator não pôde ser alcançado; nesse caso, inUse é omitido de cada entrada em robots para que o uso indisponível nunca seja relatado como zero.
  • robots: para cada tipo de Unattended Robot alocado ao tenant, a quantidade alocada (allocated) e, quando disponível, a quantidade atualmente em uso (inUse). Apenas os produtos alocados para o tenant são listados. Consulte Robôs para obter os códigos disponíveis.

robots é retornado como uma array vazia, com usageAvailable definido como false, quando o tenant não tem licença de serviço do Orchestrator ou não tem licenças de Unattended Robot alocadas. Nesse caso, nenhuma chamada é feita para o Orchestrator.

Observação:

Esse ponto de extremidade abrange apenas runtimes de robôs não assistidos (UNATT, NONPR, UNATT-HOSTING, TAUNATT, APPTESTR). Attended e outras licenças Named User não estão incluídas, pois são licenças de usuário, não runtimes. Ele também retorna a alocação para um tenant por chamada: para recuperar a alocação de robôs para cada tenant em uma organização, chame o ponto de extremidade uma vez por tenant.

Exemplo de solicitação​

A solicitação deve ser semelhante ao seguinte exemplo (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 <your-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 <your-access-token>'

Aqui está o corpo da resposta para uma recuperação de alocação de robô bem-sucedida:

{
  "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 }
  ]
}
  • Ponto de Extremidade da API​
  • Cabeçalhos de solicitação.​
  • Parâmetros do caminho​
  • Resposta​
  • 200 OK​
  • Exemplo de solicitação​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades