Orchestrator
2022.10
False
  • 入门指南
    • 读取我
    • 关于 OData 和引用
    • Orchestrator URL
    • API 参考
    • 逻辑资源和元数据
    • 可用操作
    • 枚举类型
    • 正在验证身份
    • 构建 API 请求
    • 使用外部应用程序访问 UiPath 资源
    • 每个端点的权限
    • 响应代码
    • 运行状况检查端点
  • Swagger 定义
  • Orchestrator API 使用示例
  • 平台管理 API
横幅背景图像
Orchestrator API 指南
上次更新日期 2023年11月10日

运行状况检查端点

通过对特殊端点(称为运行状况检查端点)进行 API 调用,确保所有服务均已启动并运行。

这些端点运行运行状况检查,并返回一个状态,告知您要检查的服务是否正常运行。

Orchestrator 运行状况检查端点

要检查 Orchestrator 实例及其依赖项的可用性,请使用以下端点:

  • 获取

    /api/health- 仅检查关键依赖项
  • 获取

    /api/health/startup- 检查每个依赖项

默认情况下,上述运行状况检查端点返回空响应正文。

要查看已执行的运行状况检查及其状态,请执行以下操作:

  1. 打开 UiPath.Orchestrator.dll.config 文件 (C:\Program Files (x86)\UiPath\Orchestrator)。
  2. HealthCheck.DetailsKey 设置配置密码。
  3. 在运行状况检查 API 调用中使用上述密码作为查询参数(例如 /api/health?detailsKey=password)。 如果成功,调用将返回响应正文,其中包含有关运行状况检查及其状态的详细信息。

身份服务器运行状况检查端点

要检查身份服务器是否正常工作,请使用以下端点:

  • 获取{BaseURL}/identity/.well-known/openid-configuration

此端点的响应正文总结了身份服务器配置。

Webhooks 运行状况检查端点

要检查 Webhooks 服务的可用性,请使用以下端点:

  • 获取/api/status

响应代码解释

解释响应代码,如下所示:

  • 200 OK- 您的服务已启动并正在运行
  • 5xx 失败 - 您的服务已关闭
某些运行状况检查可能会返回 200 OK 响应代码和 Degraded 状态,这意味着所检查的组件处于降级状态。

此页面是否有帮助?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath 白色徽标
信任与安全
© 2005-2024 UiPath. All rights reserved.