エラーレスポンス
EP-APIのエラー
EP-APIのリクエストでエラーが発生した場合、APIは以下の方法でクライアントプログラムにエラーを通知します。
- HTTP Status Code
- レスポンスボディ (JSON)
エンドポイントURLが誤っているなど、EP-APIのリクエストパラメータ以外にエラーの原因がある場合、APIはレスポンスパラメータを返さず、HTTP Status Codeのみを返します。
APIを呼び出すクライアントプログラムは、まずHTTP Status Codeを確認し、エラーであることが確認できた場合にレスポンスパラメータの中のErrorTypeやErrorMessage、ErrorDetailを確認するようにしてください。
エラー発生時のレスポンス形式
{ "ErrorResponse": { "RequestId": "xxxxxxxxxxxxxxxxxx", "ErrorType": "errortype", "ErrorMessage": "errormessage", "ErrorDetail": {...} } }
レスポンスパラメータ
パラメータ | タイプ | 意味 |
---|---|---|
ErrorResponse.RequestId | String | APIリクエスト毎に割り当てられるユニークなID |
ErrorResponse.ErrorType | String | エラーの原因 (以下の表参照) |
ErrorResponse.ErrorMessage | String | エラー発生原因についての説明 |
ErrorResponse.ErrorDetail | Object | エラー発生原因の詳細 |
エラーが発生した場合の対応
APIリクエスト時にエラーが発生した場合、APIを呼び出したプログラムが適切に処理を行う必要があります。
システムエラーが発生し、時間が経ってもエラーが回復しない場合は弊社サポートセンターにお問い合わせください。
共通エラー
エラー | HTTP Status Code | ErrorType | ErrorMessage | ErrorDetail | 意味 | 備考 |
---|---|---|---|---|---|---|
HTTP/1.1以外 | 505 | (なし) | HTTP1.1以外のリクエストを受け付けた | レスポンスパラメータは返却されません | ||
URL不正 | 404 | (なし) | 以下のいずれかの場合
| レスポンスパラメータは返却されません | ||
メソッド不正 | 405 | (なし) | 指定されたHTTPメソッド以外を利用した | |||
認証エラー (署名検証エラー) | 400 | BadRequest | Signature is not valid. | Signatureパラメータが存在しない | ||
Signature method is not valid. | SignatureMethodパラメータが不正 | |||||
Signature version is not valid. | SignatureVersionパラメータが不正 | |||||
Expire is not valid. | Expireパラメータが不正 | |||||
RequestExpired | The request has expired. | Expireで指定された期間を過ぎている | ||||
401 | AuthFailure | Unable to validate the provided access credentials. | 指定したAccessKeyが無効 | |||
403 | SignatureDoesNotMatch | The request signature we calculated does not match the signature you provided. | Signatureの値がリクエストの内容と合致しない | |||
パラメータエラー | 400 | ParameterError | There are invalid parameters. | 不正なパラメータが含まれている | ||
Duplicated parameter found. | パラメータが重複している | |||||
200 | (個別) | (個別) | (個別) | API固有のエラー | API固有のエラーの場合、Status Codeは200となります | |
システム障害 | 500 | SystemError | System error occurred. | API設備のシステム障害 | サポートセンターへお問い合わせください | |
タイムアウト | 503 | Timeout | System is busy. | リクエストのタイムアウト | ||
HTTPでアクセス | 403 | Required to use https. | HTTPでアクセスした | 必ずHTTPSを使用してください | ||
メンテナンス中 | 403 | StatusError | Service is stopping by maintenance. | メンテナンス中のためEP-APIを利用できない |