エラーレスポンス

DOMAIN-APIのエラー

DOMAIN-APIのリクエストでエラーが発生した場合は、APIが以下の方法でクライアントプログラムにエラーを通知します。

  1. HTTP Status Code
  2. レスポンスボディ(JSON)

アクセスURLが誤っているなど、DOMAIN-APIのリクエストパラメータ以外にエラーの原因がある場合は、APIはレスポンスパラメータを返さず、HTTP Status Codeのみを返します。APIを呼び出すクライアントプログラムは、まずHTTP Status Codeを確認し、エラーであることが確認できた場合にレスポンスパラメータの中のErrorType及びErrorMessageを確認してください。

エラー発生時のレスポンス形式

  • JSON
    Json
    {
        "ErrorResponse": {
            "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
            "ErrorType": "errortype",
            "ErrorMessage": "errormessage",
        }
    }
  • JSON(POST dj/POST dgjの場合)
    Json(POST dj/POST dgjの場合)
    { 
        "ErrorResponse" : { 
            "RequestId" : "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
            "ErrorType" : "errortype",
            "ErrorMessage" : "errormessage",
            "ErrorDetail" : {
                "Required" : [
                    "Contact.Name",
                    "Registrant.PostalCode"
                ],
                "Invalid" : [
                    "Contact.EMailAddressList",
                    "Registrant.Prefecture",
                    "StartDate"
                ]
            }
        } 
    }

レスポンス

フィールドタイプ意味
ErrorResponse.RequestIdString

APIリクエストごとに割り当てられるユニークなID

ErrorResponse.ErrorTypeString

エラーの原因

  • 詳しくは、「共通エラー」の表をご覧ください
ErrorResponse.ErrorMessageStringエラー発生原因についての説明
ErrorResponse.ErrorDetailHashエラー発生原因の詳細(POST dj/POST dgjで ParameterErrorが発生した場合)
ErrorResponse.ErrorDetail.RequiredArrayエラー発生パラメータの一覧(必須パラメータが含まれていない場合)
ErrorResponse.ErrorDetail.InvalidArrayエラー発生パラメータの一覧(不正なパラメータが含まれている場合)

エラーが発生した場合の対応

HTTP Status Codeが4xxの場合

APIリクエスト時にエラーが発生した場合は、APIを呼び出したプログラムが適切に処理を行う必要があります。HTTPヘッダや、パラメータの指定に問題がないことを確認してください。

HTTP Status Codeが5xxの場合

設定を更新するAPIを同時に指定すると、システムエラー(SystemError)が発生する場合があります。時間をおいてリトライしてください。

 時間が経ってもエラーが回復しない場合は、IIJサポートセンターにお問い合わせください。

 共通エラー

エラーHTTP Status CodeErrorTypeErrorMessage説明備考
HTTP/1.1以外505(なし) HTTP1.1以外のリクエストを受け付けましたレスポンスパラメータは返却されません
URL不正404(なし) 
  • アクセスURLが誤っています
  • 存在しないAPIが指定されました
  • 不正なAPIVersionパラメータが指定されました
  • 指定された以外のHTTPメソッドを利用しました
レスポンスパラメータは返却されません
認証エラー

(署名検証エラー)

400BadRequestSignature is not valid.Signatureパラメータが存在しません 
Signature method is not valid.不正なSignatureMethodパラメータが指定されました 
Signature version is not valid.不正なSignatureVersionパラメータが指定されました 
Expire is not valid.不正なExpireパラメータが指定されました 
RequestExpiredThe request has expired.Expireで指定された期間を過ぎています 
401AuthFailureUnable to validate the provided access credentials.無効なアクセスキーが指定されました 
403SignatureDoesNotMatchThe request signature we calculated does not match the signature you provided.リクエストの内容と合致しないSignatureの値が指定されました 
パラメータエラー400ParameterErrorThere are invalid parameters.不正なパラメータが含まれています 
Duplicated parameter found.パラメータが重複しています 
200(個別)(個別)

API固有のエラー

API固有のエラーの場合は、Statusは200となります
システム障害500SystemErrorSystem error occurred.

DOMAIN-API設備のシステム障害が発生しています

IIJサポートセンターへお問い合わせください
タイムアウト503TimeoutSystem is busy.リクエストがタイムアウトしました 
httpでアクセス403Required to use https. API呼び出し時は必ずhttpsを使用してくださいレスポンスパラメータは返却されません
メンテナンス中403StatusErrorService is stopping by maintenance.メンテナンス中のため、DOMAIN-APIを利用できません