orchestrator
2022.10
false
- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API
重要 :
请注意，此内容已使用机器翻译进行了部分本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
Orchestrator API 指南
上次更新日期 2025年2月13日
通过对特殊端点（称为运行状况检查端点）进行 API 调用，确保所有服务均已启动并运行。
这些端点运行运行状况检查，并返回一个状态，告知您要检查的服务是否正常运行。
要检查 Orchestrator 实例及其依赖项的可用性，请使用以下端点：
-
获取
https://{yourDomain}/api/health- 仅检查关键依赖项 -
获取
https://{yourDomain}/api/health/startup- 检查每个依赖项
默认情况下，上述运行状况检查端点返回空响应正文。
要查看已执行的运行状况检查及其状态，请执行以下操作：
- 打开
UiPath.Orchestrator.dll.config文件 (C:\Program Files (x86)\UiPath\Orchestrator)，在<appsettings>部分中添加<add key="HealthCheck.DetailsKey" value="12345" />。12345用作访问运行状况检查的密码，因此请不要忘记将该值更改为您自己的密码。 - 重新启动 IIS 以确保更改生效。
- 在运行状况检查 API 调用中使用先前设置的密码作为查询参数（例如
/api/health?detailsKey=password）。如果成功，调用将返回一个响应正文，其中包含有关运行状况检查及其状态的详细信息。
完成这些步骤后，也可以从 Orchestrator 服务器以外的计算机访问运行状况检查。
要检查身份服务器是否正常工作，请使用以下端点：
-
GET
https://{yourDomain}/{organizationName}/identity/.well-known/openid-configuration
此端点的响应正文总结了身份服务器配置。
要检查资源目录服务实例的可用性，请使用以下端点：
GET/https://{yourDomain}/ResourceCatalog/health
当服务已启动并正在运行时，响应正文将包含
Healthy。
