- Primeros pasos
- Sobre OData y referencias
- Tipos enumerados
- Autenticando
- Permisos por punto final
- Crear solicitudes de API
- Códigos de respuesta
- Comprobación de salud de terminales
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
Guía de la API de Orchestrator
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}/{organizationName}/{tenantName}/orchestrator_/api/health
: comprueba solo las dependencias críticas -
Obtener
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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:
- Configura el parámetro
HealthCheck.DetailsKey
enappSettings
.El valor que estableces para este parámetro sirve como contraseña que te permite acceder a las comprobaciones de estado.Ejemplo:"HealthCheck.DetailsKey":"12345"
- 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}/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.