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 health check endpoint

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

• Abrufen

  https://{yourDomain}/api/health—überprüft nur kritische Abhängigkeiten

• Abrufen

  https://{yourDomain}/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. 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

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

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

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

{
    "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": {}
            }
    }
}

Ein 500-Fehlercode signalisiert einen fehlerhaften Status, kann jedoch immer noch einen Antworttext zurückgeben. Überprüfen Sie den Inhalt des Antworttexts, um die Gründe herauszufinden.

Webhooks health check endpoint

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

• GET https://{yourDomain}/webhooks/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.