管理画面の稼働状況監視
SmartPOSTは管理画面の稼働状況のヘルスチェックエンドポイントを公開しています。以下のエンドポイントにアクセスすることで、SmartPOST管理画面の稼働状況を確認でき、監視に利用できます。
| メソッド | Base URL | エンドポイント |
|---|---|---|
| GET | https://admin.smartpost.jp | /healthcheck |
リクエストヘッダーで以下のパラメーターを指定してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| User-Agent | String | リクエスト元のアプリケーションやOS、ブラウザ、ユーザーエージェントのバージョンを識別するための文字列です。 |
| Host | String | UAT環境を利用する場合はapi-uat.smartpost.jp、本番環境を利用する場合はapi.smartpost.jpを指定してください。 |
サンプルコマンド
curl -L -X GET 'https://admin.smartpost.jp/healthcheck' \
-H 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion' \
-H 'Host: admin.smartpost.jp'
レスポンス
| HTTPレスポンス | 説明 |
|---|---|
| 200 | SmartPOST管理画面が正常に稼働しています。 |
| 403 | 何らかの理由でアクセスが禁止されていることを示します。リクエストヘッダーの内容をご確認ください。 |
| 429 | 指定された時間内に多くのリクエストが送信されたことを示します。しばらく時間が経過してからもう一度お試しください。 |
| 500 | サーバーの問題により、SmartPOST管理画面のサービス供給が停止しています。 |
| 503 | サーバーが停止していることを示しています。例えば、検証環境へ稼働時間外にリクエストを送信すると当該エラーが返却されます。 |