Health API

상태 조회

요청

Fess 에, http://<Server Name>/api/v1/health 요청을 전송하여, Fess 서버의 상태를 JSON 형식으로 받을 수 있습니다.

요청 매개변수

지정 가능한 요청 매개변수는 없습니다.

응답

다음과 같은 응답이 반환됩니다.

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

각 요소는 다음과 같습니다.

응답 정보

data	검색 결과의 부모 요소.
status	시스템 상태. 정상인 경우 green, 경고가 있는 경우 yellow, 오류가 있는 경우 red 가 반환됩니다.
timed_out	타임아웃 여부. 지정된 시간 내에 응답이 반환된 경우 false, 타임아웃된 경우 true 가 반환됩니다.

오류 응답

Health API가 실패한 경우 다음과 같은 오류 응답이 반환됩니다.

오류 응답

상태 코드	설명
500 Internal Server Error	서버 내부 오류가 발생한 경우