HealthCheck API : Get API status - NG

GET /api/1/ping.json

本APIを利用する事で、APIサーバの状態を確認できる。 なんらかの異常が発生している場合は下記のようなエラー返却される。 また、ユーザに対する詳細な情報が必要な場合 escape_url パラメータを含む。 escape_url が存在した場合、クライアントはブラウザでそのURLを開き、ユーザを誘導する必要がある。

Request

Route

GET /api/1/ping.json

Headers

Host: example.org
Cookie: 
Origin: 

Response

Headers

Content-Type: application/json; charset=utf-8
X-Ua-Compatible: IE=Edge,chrome=1
E-Tag: "0ae8575e09e44c37928f9e4bbb663f9b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: THIS_IS_SESSION_COOKIE_KEY_FOR_SPEC=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJTJlMDhhYWFkZGY1Y2MwNzJlOWRkNDlkMzdjMDNkNWUyBjsAVEkiGGtwaV9wcmV2X2NvbnRyb2xsZXIGOwBGSSIbYXBpL2hlYWx0aF9jaGVjayNpbmRleAY7AEY%3D--e80afea07509381df7a72950150344578d81fd72; path=/; HttpOnly
X-Request: 701d8e9897aee87d1758b40ea2bea87c
X-Runtime: 0.007052
Content-Length: 96

Status

200 OK

Body

{
  "error": "現在アクセスが集中しています",
  "escape_url": "http://example.com/support"
}