Endpunkte zur Zustandsprüfung

Stellen Sie sicher, dass alle Ihre Dienste betriebsbereit sind, indem Sie API-Aufrufe an spezielle Endpunkte, sogenannte Zustandsprüfungsendpunkte, senden.

Diese Endpunkte führen Systemdiagnosen aus und geben einen Status zurück, der Ihnen mitteilt, ob der Dienst, den Sie überprüfen, funktionsfähig ist oder nicht.

Orchestrator-Zustandsprüfungsendpunkt

Um die Verfügbarkeit Ihrer Orchestrator-Instanz und ihrer Abhängigkeiten zu überprüfen, verwenden Sie die folgenden Endpunkte:

• Abrufen

  /api/health—überprüft nur kritische Abhängigkeiten

• Abrufen

  /api/health/startup—überprüft jede Abhängigkeit

Standardmäßig geben die obigen Endpunkte der Zustandsprüfung einen leeren Antworttext zurück.

So sehen Sie, welche Systemdiagnosen durchgeführt wurden und welchen Status sie haben:

1. Öffnen Sie die Datei UiPath.Orchestrator.dll.config (C:\Program Files (x86)\UiPath\Orchestrator).
2. Konfigurieren Sie ein Kennwort für die Einstellung HealthCheck.DetailsKey .
3. Verwenden Sie das obige Kennwort als Abfrageparameter im API-Aufruf zur Systemdiagnose (z. B. /api/health?detailsKey=password). Bei Erfolg gibt der Aufruf einen Antworttext mit Details zu den Systemdiagnosen und deren Status zurück.

Identity Server-Zustandsprüfungsendpunkt

Um zu überprüfen, ob der Identity Server funktioniert, verwenden Sie den folgenden Endpunkt:

• GET {BaseURL}/identity/.well-known/openid-configuration

Der Antworttext dieses Endpunkts fasst die Identity Server-Konfiguration zusammen.

Webhooks-Integritätsprüfungsendpunkt

Um die Verfügbarkeit Ihres Webhooks-Dienstes zu überprüfen, verwenden Sie den folgenden Endpunkt:

• GET /api/status

Interpretation des Antwortcodes

Interpretieren Sie den Antwortcode wie folgt:

• 200 OK– Ihr Dienst ist in Betrieb
• 5xx Fehler – Ihr Dienst ist ausgefallen

Einige Systemdiagnosen geben möglicherweise einen 200 OK -Antwortcode und einen Degraded -Status zurück, was bedeutet, dass sich die überprüfte Komponente in einem herabgesetzten Zustand befindet.