Orchestrator
2022.10
False
- 入门指南
- Swagger 定义
- Orchestrator API 使用示例
- 平台管理 API
运行状况检查端点
Orchestrator API 指南
上次更新日期 2023年11月10日
运行状况检查端点
通过对特殊端点(称为运行状况检查端点)进行 API 调用,确保所有服务均已启动并运行。
这些端点运行运行状况检查,并返回一个状态,告知您要检查的服务是否正常运行。
要检查 Orchestrator 实例及其依赖项的可用性,请使用以下端点:
-
获取
/api/health
- 仅检查关键依赖项 -
获取
/api/health/startup
- 检查每个依赖项
默认情况下,上述运行状况检查端点返回空响应正文。
要查看已执行的运行状况检查及其状态,请执行以下操作:
- 打开
UiPath.Orchestrator.dll.config
文件 (C:\Program Files (x86)\UiPath\Orchestrator
)。 - 为
HealthCheck.DetailsKey
设置配置密码。 - 在运行状况检查 API 调用中使用上述密码作为查询参数(例如
/api/health?detailsKey=password
)。 如果成功,调用将返回响应正文,其中包含有关运行状况检查及其状态的详细信息。
要检查身份服务器是否正常工作,请使用以下端点:
-
获取
{BaseURL}/identity/.well-known/openid-configuration
此端点的响应正文总结了身份服务器配置。