エラーレスポンス
CAC-APIのエラー
CAC-APIのリクエストでエラーが発生した場合、APIは以下の方法でクライアントプログラムにエラーを通知します。
- HTTP Status Code
- レスポンスボディ (JSON)
アクセスURLが誤っているなど、CAC-APIのリクエストパラメータ以外にエラーの原因がある場合、APIはレスポンスパラメータを返さず、HTTP Status Codeのみを返します。APIを呼び出すクライアントプログラムは、まずHTTP Status Codeを確認し、エラーであることが確認できた場合にレスポンスパラメータの中のErrorType、ErrorMessageを確認するようにして下さい。
エラー発生時のレスポンス形式
{
"ErrorResponse": {
"RequestId": "dummy1375674759295",
"ErrorType": "errortype",
"ErrorMessage": "errormessage"
}
}
レスポンスパラメータ
| パラメータ | タイプ | 意味 |
|---|---|---|
| ErrorResponse.RequestId | String | APIリクエスト毎に割り当てられるユニークなID |
| ErrorResponse.ErrorType | String | エラーの原因 (以下の表参照) |
| ErrorResponse.ErrorMessage | String | エラー発生原因についての説明 |
エラーが発生した場合の対応
APIリクエスト時にエラーが発生した場合、APIを呼び出したプログラムが適切に処理を行う必要があります。
システムエラーが発生し、時間が経ってもエラーが回復しない場合は弊社サポートセンターにお問い合わせください。
共通エラー
| エラー | HTTP Status Code | ErrorType | ErrorMessage | 説明 | 備考 |
|---|---|---|---|---|---|
| HTTP/1.1以外 | 505 | （なし） | HTTP1.1以外のリクエストを受け付けた | レスポンスパラメータは返却されません | |
| URL不正 | 404 | （なし） |
の何れかの場合 | レスポンスパラメータは返却されません | |
| 認証エラー (署名検証エラー) | 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. | サービスコード(ServiceCode)が不正 | |
| Duplicated parameter found. | パラメータが重複している | ||||
| 200 | InvalidParameters | There are invalid parameters. | リクエストパラメータが不正 | その他、API固有のエラーの場合、Statusは200となります | |
| UnderConstruction | It is still under construction. | サービス準備中 | |||
| システム障害 | 500 | SystemError | System error occurred. | CAC-API設備のシステム障害 | サポートセンターへお問い合わせください |
| タイムアウト | 503 | Timeout | System is busy. | リクエストがタイムアウトしました | |
| httpでアクセス | 403 | Required to use https. | 必ずhttpsを使用してください | レスポンスパラメータは返却されません | |
| メンテナンス中 | 403 | StatusError | Service is stopping by maintenance. | メンテナンス中のためCAC-APIを利用できません。 |