健全性チェックのエンドポイント

健全性チェック エンドポイントと呼ばれる特別なエンドポイントに API 呼び出しを送信し、すべてのサービスが稼働中であることを確認します。

これらのエンドポイントは健全性チェックを実行し、チェックするサービスが機能しているかどうかを通知するステータスを返します。

Orchestrator health check endpoint

Orchestrator インスタンスとその依存関係が利用可能かどうかを確認するには、次のエンドポイントを使用します。

• GET

  https://{yourDomain}/api/health— 重要な依存関係のみを確認します。

• GET

  https://{yourDomain}/api/health/startup— すべての依存関係を確認します。

既定では、上記の健全性チェック エンドポイントは空の応答本文を返します。

実行された健全性チェックとそのステータスを確認するには、以下の手順を実行します。

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

Identity Server が動作しているかどうかを確認するには、次のエンドポイントを使用します。

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

このエンドポイントの応答本文に、Identity Server の構成の概要が含まれています。

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

エラー コード 500 は異常なステータスを通知しますが、それにもかかわらず応答本文が返される場合があります。応答本文の内容を確認して理由を特定してください。

Webhooks health check endpoint

Webhook サービスの利用可否を確認するには、次のエンドポイントを使用します。

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

応答コードの解釈

応答コードは次のように解釈します。

• 200 OK — サービスは起動し、実行されています。
• 5xx 失敗 — サービスは停止しています。

健全性チェックによっては、応答コード 200 OK とステータス Degraded が返されることがあります。これは、チェックされたコンポーネントが機能低下のステートになっていることを意味します。