Error Code

    APIの呼び出しの成否はHTTP Status Codeで示され、エラーの詳細はResponse BodyにJSON形式で含まれるError Objectで確認できます。
    APIの呼び出しが失敗した場合には、通常は、クライアントからのリクエストが原因であることを示すHTTP Status Code 4xxか、サーバー エラーを示すHTTP Status Code 5xxが返されます。

    HTTP Status Codes

    主に発生するHTTP Status Codeは以下のとおりです。

    Status Code Reason Phrase
    400 Bad Request
    401 Unauthorized
    403 Forbidden
    404 Not Found
    405 Method Not Allowed
    409 Conflict
    410 Gone
    415 Unsupported Media Type
    429 Too Many Requests
    500 Internal Server Error
    503 Service Unavailable

    Response bodyに含まれるJSON Error Object

    詳細なエラー内容が提供可能な場合には、HTTP Response Bodyに含まれる以下のJSON Error Objectによりエラー内容が示されます。
    エラー原因の概要はcodeに示され、エラーの原因の特定に有用な情報はdescriptionに記載されます。

    {
      "code": "ERROR_CODE",
      "description": "error description"
    }
    

    Error Codeの説明

    発生するError Codeの説明は以下の通りです。

    HTTP Status Code Error Code 説明
    400 BAD_REQUEST クライアントからの誤った形式または内容の要求による一般的なエラー
    400 INVALID_PARAMETER クライアントからのリクエストに含まれるパラメータの形式または内容に問題がある
    400 INVALID_{RESOURCE} クライアントから要求されたリソースの内容に問題がある
    400 MISSING_PARAMETER 呼び出しに必要なパラメータが不足している
    400 LIMIT_EXCEEDED パラメータまたはリソースの制限を超えた
    400 OUT_OF_RANGE パラメータまたはリソースの制限の範囲外
    401 UNAUTHORIZED 必要な認証情報が欠落しているか誤っている
    一般的な認証エラーは RFC 6749を確認してください
    403 FORBIDDEN サーバーはリクエストの内容を理解したが、拒否した
    アクセス対象のリソースへのアクセス権がない場合や、アプリがアクセス対象のリソースへのOAuthスコープを保持していない場合も含みます
    403 ACCESS_DENIED クライアントが要求したリソースへのアクセスが制限されている
    403 LIMIT_EXCEEDED クライアントが要求したリソースの制限を超えた
    403 OUT_OF_RANGE クライアントが要求したリソースの制限の範囲外
    404 NOT_FOUND クライアントが要求したリソースが存在しない
    404 {RESOURCE}_NOT_EXIST クライアントが要求した特定のリソースが存在しない
    409 CONFLICT クライアントが要求したリソースで競合が発生した
    409 ALREADY_EXIST クライアントが作成しようとしたリソースが既に存在する
    409 {RESOURCE}_ALREADY_EXIST クライアントが作成しようとした特定のリソースが既に存在する
    410 DELETED クライアントが削除しようとしたリソースが既に削除されており、サーバーに存在しない
    500 INTERNAL_SERVER_ERROR サーバーの内部エラー
    503 SERVICE_UNAVAILABLE 一時的なサーバーエラー