- Primeros pasos
- La definición de Swagger
- Ejemplos de uso de la 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
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:
- In the
orchestrator-customconfig
config map (configured viaorchestrator-configurator.sh
), andadd<add key="HealthCheck.DetailsKey" value="12345" />
in the<appsettings>
section.12345
serves as a password which allows you to access the health checks, so do not forget to change it with a value of your own. - Restart IIS to ensure that the change takes effect.
- Use the previously set password as a query parameter in the health check API call (for example,
/api/health?detailsKey=password
). If successful, the call returns a response body containing details about the health checks and their statuses.
Once you complete these steps, the health check will also be accessible from a machine different to the Orchestrator server.
Para comprobar si el Identity Server funciona, utilice el siguiente punto de conexión:
-
OBTENER
{BaseURL}/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
when the service is up and running.
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.