Orchestrator
2022.10
偽
- 基本情報
- Swagger 定義
- Orchestrator API の使用例
- プラットフォーム管理 API
健全性チェックのエンドポイント
Orchestrator API ガイド
最終更新日 2023年11月10日
健全性チェックのエンドポイント
健全性チェック エンドポイントと呼ばれる特別なエンドポイントに API 呼び出しを送信し、すべてのサービスが稼働中であることを確認します。
これらのエンドポイントは健全性チェックを実行し、チェックするサービスが機能しているかどうかを通知するステータスを返します。
Orchestrator インスタンスとその依存関係が利用可能かどうかを確認するには、次のエンドポイントを使用します。
-
GET
/api/health
— 重要な依存関係のみを確認します。 -
GET
/api/health/startup
— すべての依存関係を確認します。
既定では、上記の健全性チェック エンドポイントは空の応答本文を返します。
実行された健全性チェックとそのステータスを確認するには、以下の手順を実行します。
- Open the
UiPath.Orchestrator.dll.config
file (C:\Program Files (x86)\UiPath\Orchestrator
). HealthCheck.DetailsKey
設定のパスワードを設定します。- このパスワードは、健全性チェック API 呼び出しでクエリ パラメーターとして使用します (例:
/api/health?detailsKey=password
)。成功した場合、この呼び出しは、健全性チェックとそのステータスの詳細を含む応答本文を返します。
Identity Server が動作しているかどうかを確認するには、次のエンドポイントを使用します。
-
GET
{BaseURL}/identity/.well-known/openid-configuration
このエンドポイントの応答本文に、Identity Server の構成の概要が含まれています。