マニュアルアカデミーカスタムカードギャラリー公開レシピヘルプログイン新規登録
マニュアルアカデミーカスタムカードギャラリー公開レシピヘルプログイン新規登録
page icon
トップ/マニュアル/📙API一覧//helthz

/helthz

💡
ヘルスチェックAPIの仕様書です

用途

アプリケーションのHTTPサーバ機能が正常に動作しているかどうかを確認します。

仕様

リクエスト

エンドポイント

項目内容
メソッド
パス

ヘッダー

ヘッダー値

ボディ

リクエストボディは不要です。

実行例

レスポンス

ヘッダー

ヘッダー値

ボディ

項目型説明
stringアプリケーションの稼働状態。正常時はが返ります。

成功例

確認方法

  • 正常時のHTTPステータスが［例：］であることを確認します。
  • レスポンスのが［正常時の値］であることを確認します。

ステータスコード

HTTPステータス主な発生条件対処方法
成功
アプリケーションで内部エラーが発生コンテナの稼働状態とログを確認します。

トラブルシューティング

正常なレスポンスが返らない

  • コンテナの稼働状態とログを確認します。
  • アプリケーションが起動していることを確認します。
  • ホスト名、ポート番号およびエンドポイントが正しいことを確認します。