orchestrator
2021.10
false
- 基本情報
- OData と参照について
- 列挙型
- 認証
- API リクエストを構築する
- エンドポイントごとの権限
- 応答コード
- 健全性チェックのエンドポイント
- Swagger の定義
- Orchestrator API
健全性チェックのエンドポイント
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Orchestrator API ガイド
健全性チェックのエンドポイント
健全性チェック エンドポイントと呼ばれる特別なエンドポイントに API 呼び出しを送信し、すべてのサービスが稼働中であることを確認します。
これらのエンドポイントは健全性チェックを実行し、チェックするサービスが機能しているかどうかを通知するステータスを返します。
Orchestrator インスタンスとその依存関係が利用可能かどうかを確認するには、次のエンドポイントを使用します。
-
GET
https://{yourDomain}/api/health
— 重要な依存関係のみを確認します。 -
GET
https://{yourDomain}/api/health/startup
— すべての依存関係を確認します。
既定では、上記の健全性チェック エンドポイントは空の応答本文を返します。
実行された健全性チェックとそのステータスを確認するには、以下の手順を実行します。
orchestrator-customconfig
構成マップ (orchestrator-configurator.sh
で設定) で、「<appsettings>
」セクションに<add key="HealthCheck.DetailsKey" value="12345" />
を追加します。12345
は健全性チェックにアクセスするパスワードとして機能するため、独自の値に変更することを忘れないでください。- IIS を再起動して、変更が反映されていることを確認します。
- 設定したパスワードを、健全性チェック API 呼び出しでクエリ パラメーターとして使用します (例:
/api/health?detailsKey=password
)。成功した場合、この呼び出しは、健全性チェックとそのステータスの詳細を含む応答本文を返します。
これらの手順を完了すると、Orchestrator サーバーとは別のマシンからも健全性チェックにアクセスできるようになります。
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": {}
}
}
}
{
"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 は異常なステータスを通知しますが、それにもかかわらず応答本文が返される場合があります。応答本文の内容を確認して理由を特定してください。
Webhook サービスの利用可否を確認するには、次のエンドポイントを使用します。
-
GET
https://{yourDomain}/webhooks/api/status