Health API

このドキュメントでは、 Fess の v2 Health API について説明します。 共通のレスポンスエンベロープ・エラーモデルについては APIの概要 を参照してください。

ベースURLは http://<Server Name>/api/v2/ です（ローカル環境の例: http://localhost:8080/api/v2 ）。

状態の取得

リクエスト

HTTPメソッド	GET
エンドポイント	/api/v2/health

検索エンジンクラスターの状態スナップショットを返します（ monitor タグ）。 HTTP ステータスは、クラスターの状態が green / yellow の場合は 200、 red の場合は 503 になります。

このエンドポイントはエンベロープの不変条件「 status >= 1 ⇔ HTTP ステータス >= 400 」を守ります。

• green / yellow の場合: 成功エンベロープ（ status: 0 ）で engine を返します。

• red の場合: エラーエンベロープ（ status: 9 , error.code: service_unavailable ）を返し、エンジンスナップショットを error.details.engine の下に埋め込みます（監視ツールがクラスターメタデータを解析できるようにするため）。

engine の各フィールドは以下の通りです。

engine フィールド

cluster_name	クラスター名（str）。
status	クラスターの状態。 green / yellow / red のいずれか。
ping_status	ping のステータス（int）。

表: engine フィールド

リクエストパラメーター

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

レスポンス

クラスターが green / yellow の場合（200）は、成功エンベロープで engine が返ります。

{
  "response": {
    "status": 0,
    "engine": {
      "cluster_name": "fess-es",
      "status": "green",
      "ping_status": 0
    }
  }
}

クラスターが red の場合（503）は、エラーエンベロープで返り、エンジンスナップショットが error.details.engine の下に埋め込まれます。

{
  "response": {
    "status": 9,
    "error": {
      "code": "service_unavailable",
      "message": "Cluster is unavailable.",
      "details": {
        "engine": {
          "cluster_name": "fess-es",
          "status": "red",
          "ping_status": 2
        }
      }
    }
  }
}

使用例

curl コマンドでのリクエスト例:

curl "http://localhost:8080/api/v2/health"

レスポンス・エラーレスポンス

エラーモデルの詳細は APIの概要 を参照してください。このエンドポイントが返す HTTP ステータスは以下の通りです。

レスポンス一覧

ステータスコード	説明
200 OK	クラスターが green / yellow で到達可能な場合。成功エンベロープに engine が含まれます。
405 Method Not Allowed	HTTP メソッドが許可されていない場合。
503 Service Unavailable	クラスターが red の場合。エラーエンベロープ（ error.code: service_unavailable ）で error.details.engine にエンジンスナップショットが含まれます。

表: レスポンス一覧