ステータスコード

奉行クラウド API のリクエストが、成功、または、失敗したかを示す主な HTTP ステータスコードの一覧です。
そのほか記載のないステータスコードは、RFC 7231（6. Response Status Codes）に準拠します。

レート・クォータ制限

奉行クラウド API では、リクエスト回数とデータ転送量（リクエストとレスポンスの合計サイズ）に対して上限値を設定しています。
レートとクォータの上限値を超えた場合は、API のリクエストを一時的に受け付けずに、エラーレスポンスを送信します。

基本カテゴリ

すべての奉行クラウド API 呼び出し時に、Request Header に指定する「X-OBC-SubscriptionKey」と「X-OBC-TenantID」ごとに、リクエスト回数とデータ転送量を計測します。

バイナリデータ API カテゴリ

バイナリデータを Upload／Download する API の呼び出し時に、Request Header に指定する「X-OBC-SubscriptionKey」と「X-OBC-TenantID」ごとに、基本カテゴリとは別にリクエスト回数とデータ転送量を計測します。

共通 API カテゴリ

Authorization API／Management API 呼び出し時に、Request Header に指定する「X-OBC-SubscriptionKey」ごとに、基本カテゴリとは別にリクエスト回数とデータ転送量を計測します。

上限値を超えた場合のエラーレスポンスのヘッダーとボディには、制限解除までの秒数、または時間が記載されます。

Response Header

Retry-After: XXXXXX（制限が解除されリトライできるまでの秒数）
{
    ...
}

Response Body（429：Too Many Requests）

{
    "message": "Rate limit is exceeded. Try again in X seconds."（リトライできるまでの秒数） 
}

Response Body（403：Quota Exceeded）

{
    "message": "Out of bandwidth quota. Quota will be replenished in hh:㎜:ss." 
}

エラーレスポンス

API リクエストに対し、ステータスコードが 200 以外の場合には、原因がレスポンスボディの message にセットされます。
また、エラー原因によっては詳細な情報が details にセットされる場合があります。

Response Body

{
    "message": "パラメータが正しくありません。",
    "details": [
        {
            "message": "指定された値が正しくありません。",
            "target": "ID"
        }
    ]
}

schema.json

{
    "description": "Error",
    "type": "object",
    "properties": {
        "message": {
            "type": "string"
        },
        "details": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string"
                    },
                    "target": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

Internal Server Error の エラーレスポンス

『奉行クラウド』の動作に問題が発生した場合、ネットワークやリソースの負荷により処理に問題が発生した場合に、500（Internal Server Error）が発生することがあります。
500（Internal Server Error）が発生した際のエラーレスポンスは以下の通りです。

Response Body（『奉行クラウド』にて問題が発生した場合）

{
    "message" : "Schema: {Schemaを示す文字列}\r\nErrorLogID: {ログIDを示す文字列}" 
}

Response Body（ネットワークやリソースの負荷により処理に問題が発生した場合）

{
    "message" : "Temporary error occurred on the server. Please wait for a while and try again.", 
    "reason" : "BackendConnectionFailure"
}

参考
「BackendConnectionFailure」のエラーの場合、一時的に API ゲートウェイと『奉行クラウド』の接続が切断されたことを示します。
この場合、リトライして正常なレスポンスが返却されるかお試しください。
リトライについては、こちら をご参照ください。