Health API

状態の取得

Fess に、 http://<Server Name>/api/v1/health のリクエストを送ることで、 Fess のサーバーの状態をJSON形式で受け取ることができます。

リクエストパラメーター

指定できるリクエストパラメーターはありません。

レスポンス

以下のようなレスポンスが返ります。

{
  "data": {
    "status": "green",
    "timed_out": false
  }
}

各要素については以下の通りです。

data	検索結果の親要素。
status	レスポンスのステータス。正常の場合はgreenが返却されます。
timed_out	レスポンスの結果。指定された時間内にレスポンスが返された場合はfelseが返却されます。

表: レスポンス情報