Points de terminaison de vérification de l'état

Assurez-vous que tous vos services sont opérationnels en effectuant des appels d'API vers des points de terminaison spéciaux, appelés points de terminaison de vérification de l'état.

Ces points de terminaison exécutent des vérifications de l'état et renvoient un statut qui vous indique si le service que vous vérifiez est fonctionnel ou non.

Point de terminaison de vérification de l’état d’Orchestrator

Pour vérifier la disponibilité de votre instance Orchestrator et de ses dépendances, utilisez les points de terminaison suivants :

• Obtenir

  https://{yourDomain}/api/health: vérifie uniquement les dépendances critiques

• Obtenir

  https://{yourDomain}/api/health/startup: vérifie chaque dépendance

Par défaut, les points de terminaison de vérification de l'état ci-dessus renvoient un corps de réponse vide.

Pour voir quelles vérifications de l'état ont été effectuées et les statuts qu'elles possèdent :

1. Dans la carte de configuration orchestrator-customconfig (configurée via orchestrator-configurator.sh), et
   ajoutez <add key="HealthCheck.DetailsKey" value="12345" /> dans la section <appsettings>. 12345 est le mot de passe permettant d'accéder aux vérifications de l'état : n'oubliez pas de le remplacer par la valeur de votre choix.
2. Redémarrez IIS pour vous assurer que la modification est effective.
3. Utilisez le mot de passe défini précédemment comme paramètre de requête dans l'appel API de vérification de l'état (par exemple /api/health?detailsKey=password). Si celui-ci est correct, l'appel renverra un corps de réponse contenant des détails sur les vérifications de l'état et les statuts associés.

Une fois ces étapes terminées, la vérification de l'état sera également accessible depuis une machine distincte du serveur Orchestrator.

Point de terminaison Identity Server pour la vérification de l’état

Pour vérifier si le serveur d'identité fonctionne, utilisez le point de terminaison suivant :

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

Le corps de la réponse de ce point de terminaison résume la configuration du serveur d'identité.

{
    "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 code d'erreur 500 signale un état défectueux, mais peut toujours renvoyer un corps de réponse. Vérifiez le contenu du corps de la réponse pour en connaître les raisons.

Point de terminaison Webhooks pour la vérification de l’état

Pour vérifier la disponibilité de votre service Webhooks, utilisez le point de terminaison suivant :

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

Interprétation du code de réponse

Interprétez le code de réponse comme suit :

• 200 OK: votre service est opérationnel
• Échec de5xx : votre service est en panne

Certaines vérifications de l'état peuvent renvoyer un code de réponse 200 OK et un statut Degraded , ce qui signifie que le composant vérifié est dans un état dégradé.