运行状况检查端点

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

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

Orchestrator 运行状况检查端点

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

• 获取

  https://{yourDomain}/api/health- 仅检查关键依赖项

• 获取

  https://{yourDomain}/api/health/startup- 检查每个依赖项

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

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

1. 在 orchestrator-customconfig 配置映射中（通过 orchestrator-configurator.sh 配置），
   在 <appsettings> 部分中添加 <add key="HealthCheck.DetailsKey" value="12345" />。12345 用作访问运行状况检查的密码，因此请不要忘记将该值更改为您自己的密码。
2. 重新启动 IIS 以确保更改生效。
3. 在运行状况检查 API 调用中使用先前设置的密码作为查询参数（例如 /api/health?detailsKey=password）。如果成功，调用将返回一个响应正文，其中包含有关运行状况检查及其状态的详细信息。

完成这些步骤后，也可以从 Orchestrator 服务器以外的计算机访问运行状况检查。

Identity 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": {}
            }
    }
}

500 错误代码表示状态不正常，但仍可能返回响应正文。 检查响应正文内容以找出原因。

Webhook 运行状况检查端点

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

• 获取https://{yourDomain}/webhooks/api/status

资源目录服务运行状况检查端点

要检查资源目录服务实例的可用性，请使用以下端点：

• GET/https://{yourDomain}/ResourceCatalog/health

当服务已启动并正在运行时，响应正文将包含 Healthy。

响应代码解释

解释响应代码，如下所示：

• 200 OK- 您的服务已启动并正在运行
• 5xx 失败 - 您的服务已关闭

某些运行状况检查可能会返回 200 OK 响应代码和 Degraded 状态，这意味着所检查的组件处于降级状态。