健康检查API
获取状态
请求
| HTTP方法 | GET |
| 端点 | /api/v1/health |
向 Fess 发送 http://<Server Name>/api/v1/health 请求,可以获取 Fess 服务器状态的JSON格式数据。
请求参数
无可用的请求参数。
响应
将返回以下响应:
{
"data": {
"status": "green",
"timed_out": false
}
}
各元素说明如下:
| data | 搜索结果的父元素。 |
| status | 系统状态。正常时返回 green,有警告时返回 yellow,有错误时返回 red。 |
| timed_out | 超时状态。在指定时间内返回响应时为 false,超时时为 true。 |
错误响应
当健康检查API失败时,将返回以下错误响应:
| 状态码 | 说明 |
| 500 Internal Server Error | 服务器内部错误 |