- Démarrage
- Lisez-moi
- À propos d'OData et des références
- URL d'Orchestrator
- Références d'API
- Ressources logiques et métadonnées
- Opérations disponibles
- Fichiers énumérés (Enumerated Files)
- Authentification
- Création des requêtes d'API
- Accèder aux ressources UiPath à l'aide d'applications externes
- Autorisations par point de terminaison
- Codes de réponse
- Points de terminaison de vérification de l'état
- Définition Swagger
- Exemples d'utilisation de l'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
- API de gestion de plate-forme
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
/api/health
: vérifie uniquement les dépendances critiques -
Obtenir
/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 :
- Ouvrez le fichier
UiPath.Orchestrator.dll.config
(C:\Program Files (x86)\UiPath\Orchestrator
). - Configurez un mot de passe pour le paramètre
HealthCheck.DetailsKey
. - Utilisez le mot de passe ci-dessus comme paramètre de requête dans l'appel d'API de vérification de l'état (par exemple,
/api/health?detailsKey=password
). En cas de succès, l'appel renvoie un corps de réponse contenant des détails sur les vérifications de l'état et leurs statuts.
Pour vérifier si le serveur d'identité fonctionne, utilisez le point de terminaison suivant :
-
LIRE
{BaseURL}/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
/api/status
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é.