Orchestrator
2021.10
False
Imagen de fondo del banner
Guía de la API de Orchestrator
Última actualización 19 de abr. de 2024

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.

Orchestrator health check endpoint

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:

  1. Open the UiPath.Orchestrator.dll.config file (C:\Program Files (x86)\UiPath\Orchestrator), and
    add <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.
  2. Restart IIS to ensure that the change takes effect.
  3. 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.

Identity Server health check endpoint

Para comprobar si el Identity Server funciona, utilice el siguiente punto de conexión:

  • OBTENER https://{yourDomain}/identity/health

El cuerpo de respuesta de este punto final resume la configuración de Identity Server.

{
    "status": "Healthy",
    "results": {
        "ApplicationDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "AuditDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "PersistedGrantDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "IdentityServerConfigurationDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            }
    }
}{
    "status": "Healthy",
    "results": {
        "ApplicationDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "AuditDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "PersistedGrantDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "IdentityServerConfigurationDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            }
    }
}

Un código de error 500 indica un estado incorrecto, sin embargo, puede devolver un cuerpo de respuesta. Compruebe el contenido del cuerpo de la respuesta para conocer los motivos.

Webhooks health check endpoint

Para comprobar la disponibilidad de tu servicio Webhooks, utiliza el siguiente punto de conexión:

  • OBTENER https://{yourDomain}/webhooks/api/status

Interpretación del código de respuesta

Interprete el código de respuesta de la siguiente manera:

  • 200 OK: su servicio está en funcionamiento
  • 5xx error: su servicio está inactivo
Algunas comprobaciones de estado pueden devolver un código de respuesta 200 OK y un estado Degraded , lo que significa que el componente marcado está en un estado degradado.

Was this page helpful?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Logotipo blanco de UiPath
Confianza y seguridad
© 2005-2024 UiPath. All rights reserved.