- Primeros pasos
- About OData and references
- Tipos enumerados
- Autenticando
- Crear solicitudes de API
- Permissions per endpoint
- Response codes
- Comprobación de salud de terminales
- Autenticación
- Swagger definition
- API de Orchestrator
- Alerts requests
- Solicitudes de activos
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Solicitudes de permisos
- Processes requests
- Queue Items requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Solicitudes de tenants
- Transactions requests
- Users requests
- Webhooks requests
- API de gestión de plataformas

Orchestrator API guide
Comprobación de salud de terminales
Asegúrate de que todos tus servicios están en funcionamiento realizando llamadas a la API a puntos finales especiales, llamados puntos finales de comprobación de estado.
Estos puntos finales ejecutan comprobaciones de estado y devuelven un estado que te indica si el servicio que estás comprobando funciona o no.
Para comprobar la disponibilidad de tu instancia de Orchestrator y sus dependencias, utiliza los siguientes puntos de conexión:
-
Obtener
https://{yourDomain}/api/health
: comprueba solo las dependencias críticas -
Obtener
https://{yourDomain}/api/health/startup
: comprueba todas las dependencias
De forma predeterminada, los puntos finales de las comprobaciones de estado anteriores devuelven un cuerpo de respuesta vacío.
Para ver qué comprobaciones de estado se han realizado y los estados que tienen:
- Abra el archivo
UiPath.Orchestrator.dll.config
(C:\Program Files (x86)\UiPath\Orchestrator
) yañadir<add key="HealthCheck.DetailsKey" value="12345" />
en la sección<appsettings>
.12345
sirve como contraseña que le permite acceder a las comprobaciones de estado, así que no olvide cambiarla con un valor propio. - Reinicie IIS para asegurarse de que el cambio surta efecto.
- Utilice la contraseña establecida previamente como parámetro de consulta en la llamada a la API de comprobación de estado (por ejemplo,
/api/health?detailsKey=password
). Si se realiza correctamente, la llamada devuelve un cuerpo de respuesta que contiene detalles sobre las comprobaciones de estado y sus estados.
Una vez que complete estos pasos, también se podrá acceder a la comprobación de estado desde una máquina diferente al servidor de Orchestrator.
Para comprobar si el Identity Server funciona, utilice el siguiente punto de conexión:
-
GET
https://{yourDomain}/{organizationName}/identity
/.well-known/openid-configuration
El cuerpo de respuesta de este punto final resume la configuración de Identity Server.
Para comprobar la disponibilidad de tu servicio Webhooks, utiliza el siguiente punto de conexión:
-
OBTENER
https://{yourDomain}/webhooks/api/status
GET/https://{yourDomain}/ResourceCatalog/health
Healthy
cuando el servicio está en funcionamiento.
Interprete el código de respuesta de la siguiente manera:
200 OK
: su servicio está en funcionamiento5xx
error: su servicio está inactivo
200 OK
y un estado Degraded
, lo que significa que el componente marcado está en un estado degradado.