- Introdução
- Definição do Swagger
- Exemplos usando a API do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
- APIs de gestão de plataforma
Pontos de extremidade de verificação de integridade
Certifique-se de que todos os seus serviços estejam funcionando, fazendo chamadas de API para endpoints especiais, chamados endpoints de verificação de integridade.
Esses endpoints executam verificações de integridade e retornam um status que informa se o serviço que você está verificando está funcionando ou não.
Para verificar a disponibilidade de sua instância do Orchestrator e suas dependências, use os seguintes endpoints:
-
Obter
https://{yourDomain}/api/health
— verifica apenas dependências críticas -
Obter
https://{yourDomain}/api/health/startup
— verifica todas as dependências
Por padrão, os endpoints de verificação de integridade acima retornam um corpo de resposta vazio.
Para ver quais verificações de integridade foram realizadas e os status que elas possuem:
- Abra o arquivo
UiPath.Orchestrator.dll.config
(C:\Program Files (x86)\UiPath\Orchestrator
). - Configure uma senha para a configuração
HealthCheck.DetailsKey
. - Use a senha acima como um parâmetro de consulta na chamada API de verificação de integridade (por exemplo,
/api/health?detailsKey=password
). Se for bem-sucedida, a chamada retornará um corpo de resposta contendo detalhes sobre as verificações de integridade e seus status.
Para verificar se o servidor de identidade está funcionando, use o seguinte endpoint:
-
OBTER
{BaseURL}/identity/.well-known/openid-configuration
O corpo da resposta desse endpoint resume a configuração do Identity Server.
Para verificar a disponibilidade do seu serviço Webhooks, use o seguinte endpoint:
-
OBTER
{notApplicable}/api/status
Interprete o código de resposta da seguinte maneira:
200 OK
—seu serviço está funcionando5xx
falha—seu serviço está inativo
200 OK
e um status Degraded
, o que significa que o componente verificado está em um estado degradado.