エラー情報
リクエスト内容もしくはサーバでの処理中にエラーが発生した場合にはエラーレスポンスを返します。
エラーの種類は HTTP のレスポンスステータスコードで判別し、詳細はレスポンスボディの文字列で識別してください。
ステータスコードの400番台はクライアントエラーで、500番台はサーバエラーとなります。
以下に記載の内容は、返却されるエラーの一例です。
エラーハンドリングされる場合は、ステータスコードをもとにご対応ください。
以下のどちらかの形式で表示されます
{
"status_code": HTTPレスポンスステータスコード,
"message": "エラーメッセージ"
}
{
"message": "エラーメッセージ"
}
HTTPレスポンスステータスコードが4xx番台
| HTTPレスポンスステータスコード | エラーメッセージ | 発生理由 | 備考 |
|---|---|---|---|
| 400 | This request path is invalid | リクエストパスが不正 | |
| 400 | This API is invalid | リクエスト API が不正 | 許可されていないAPIパスへリクエストした場合 |
| 400 | access count exceeded error | リアクセス回数制限を超過 | トライアル環境で発生する場合があります |
| 401 | This client is invalid | 認証に失敗した | 無効なclient_idを指定した場合 |
| 401 | This signature is invalid | 署名に誤りがある | ・無効な署名を指定した場合 ・シグネチャ認証に失敗した場合 ・認証キーが不一致の場合 |
| 403 | Invalid CID | クライアントIDが不明 | |
| 403 | Forbidden | WAF(ウェブアプリケーションファイアフォール)によりアクセスが遮断された | |
| 405 | This http method is invalid : {method} | 許可されていないHTTPメソッドを使用 | POST専用APIにGETでアクセスした場合など |
| 414 | URI too long | リクエスト長の上限を超えている | |
| 429 | Too Many Requests | 一定時間内に大量のリクエストを送信(レートリミットを超過) |
HTTPレスポンスステータスコードが5xx番台
| HTTPレスポンスステータスコード | エラーメッセージ | 発生理由 | 備考 |
|---|---|---|---|
| 500 | The specified route is not found. | 指定された条件に該当する経路が見つからない | |
| 500 | This route does not observe the distance limit. | 指定された条件が距離制限を超えている | |
| 500 | link shape is not exists. | 該当の路線形状が見つからない | |
| 500 | internal error | ルート関連の不整合が発生 | |
| 500 | server error | サーバ側で不整合が発生 | |
| 503 | server error | サーバ側でアクセスを制限している | |
| 504 | Endpoint request timed out | サーバ側でタイムアウトが発生 | |
| 504 | URL execution timeout | サーバ側でタイムアウトが発生(POST通信時) |