Orchestrator
2021.10
False
运行状况检查端点
Orchestrator API 指南
上次更新日期 2024年4月19日
运行状况检查端点
通过对特殊端点(称为运行状况检查端点)进行 API 调用,确保所有服务均已启动并运行。
这些端点运行运行状况检查,并返回一个状态,告知您要检查的服务是否正常运行。
要检查 Orchestrator 实例及其依赖项的可用性,请使用以下端点:
-
获取
https://{yourDomain}/api/health
- 仅检查关键依赖项 -
获取
https://{yourDomain}/api/health/startup
- 检查每个依赖项
默认情况下,上述运行状况检查端点返回空响应正文。
要查看已执行的运行状况检查及其状态,请执行以下操作:
- Open the
UiPath.Orchestrator.dll.config
file (C:\Program Files (x86)\UiPath\Orchestrator
), andadd<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. - Restart IIS to ensure that the change takes effect.
- 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.
要检查身份服务器是否正常工作,请使用以下端点:
-
获取
https://{yourDomain}/identity/health
此端点的响应正文总结了身份服务器配置。
{
"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 错误代码表示状态不正常,但仍可能返回响应正文。 检查响应正文内容以找出原因。
要检查 Webhooks 服务的可用性,请使用以下端点:
-
获取
https://{yourDomain}/webhooks/api/status