- Démarrage
- À propos d'OData et des références
- Fichiers énumérés (Enumerated Files)
- Authentification
- Création des requêtes d'API
- Autorisations par point de terminaison
- Codes de réponse
- Points de terminaison de vérification de l'état
- Définition Swagger
- API Orchestrator
- Demandes d'alertes
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches génériques
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes d'espaces de travail personnels
- Requêtes relatives aux processus
- Demandes d'éléments de la file d'attente
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
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.
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 :
- Dans la carte de configuration
orchestrator-customconfig
(configurée viaorchestrator-configurator.sh
), etajoutez<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. - Redémarrez IIS pour vous assurer que la modification est effective.
- 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.
Pour vérifier si le serveur d'identité fonctionne, utilisez le point de terminaison suivant :
-
GET
https://{yourDomain}/identity
/.well-known/openid-configuration
Le corps de la réponse de ce point de terminaison résume la configuration du serveur d'identité.
Pour vérifier la disponibilité de votre service Webhooks, utilisez le point de terminaison suivant :
-
LIRE
https://{yourDomain}/webhooks/api/status
GET/https://{yourDomain}/ResourceCatalog/health
Healthy
lorsque le service est opérationnel.
Interprétez le code de réponse comme suit :
200 OK
: votre service est opérationnel- Échec de
5xx
: votre service est en panne
200 OK
et un statut Degraded
, ce qui signifie que le composant vérifié est dans un état dégradé.
- Point de terminaison de vérification de l’état d’Orchestrator
- Point de terminaison de vérification de l'état du serveur d'identité
- Point de terminaison Webhooks pour la vérification de l’état
- Point de terminaison du Service de catalogue de ressources pour la vérification de l’état
- Interprétation du code de réponse