錯誤碼
為方便您在使用過程中進行問題定位,本文將介紹網關的錯誤碼信息。
簡介
網關提供了錯誤碼及相關解決方案。一個錯誤碼的完整信息包括結果碼、HTTP 狀態碼、memo 和 tips。
結果碼是網關定義的返回碼,用來標識一個請求的響應狀態。
每一個結果碼都對應一個標準的 HTTP 狀態碼。
memo 表示當前結果碼的結果信息。
tips 是針對當前結果碼的說明。
常見錯誤碼
API 請求異常
在調用 API 請求異常時,常見的錯誤碼信息如下表所示:
結果碼 | HTTP 狀態碼 | 結果信息(memo) | 說明(tips) |
---|---|---|---|
3000 | 400 | RouterNotFound | 網關不存在該 API。 |
3001 | 400 | RouterGroupNotFound | 網關不存在該 API 分組。 |
API 請求異常的原因可能是控制臺沒有下發配置或者網關沒有及時更新配置。
排查方式如下:
檢查網關是否配置了相應的 API 且 API 的狀態是否為 已發布。
檢查客戶端的 API 調用路徑和分組等信息是否與網關維護的一致。
檢查請求的 host、path、method 是否正確。
加簽/驗簽失敗
在對網關進行加簽/驗簽操作失敗時,常見錯誤碼如下表所示:
網關結果碼 | HTTP 狀態碼 | 結果信息(memo) | 說明(tips) |
---|---|---|---|
2100 | 400 | RequestSignatureNotFound | 網關對沒有獲取到客戶端請求的簽名信息。 |
2102 | 400 | RequestSignatureVerifyError | 網關對客戶端請求簽名校驗失敗。 |
2103 | 502 | RequestReSignatureError | 網關對服務端請求加簽失敗。 |
2104 | 400 | ResponseSignatureVerifyError | 網關對服務端響應簽名校驗失敗。 |
檢查客戶端的 AK/SK 是否配置正確。
說明關閉 API 或者后端系統集群的安全認證,調試是否調用成功。 如果成功,則說明是加簽驗簽的問題,再加上 AK/SK 之后看還是否成功。
檢查加簽的算法類型是否支持,目前僅支持 SHA256 算法。
全部錯誤碼
網關結果碼 | HTTP 狀態碼 | 結果信息(memo) | 說明(tips) |
---|---|---|---|
1000 | 200 | success | 請求成功。 |
1002 | 429 | TooManyRequests | 請求被網關限流,請前往 API詳情頁 > 流量治理 查看并調整限流條件。 |
1100 | 200 | DefaultMockStatus | 返回 mock 響應。 |
1800 | 100 | BizHttpContinue | 業務結果碼,請查看后端服務日志。 |
1801 | 201 | BizCreated | 業務結果碼,請查看后端服務日志。 |
1802 | 202 | BizAccepted | 業務結果碼,請查看后端服務日志。 |
1803 | 203 | BizNonAuthoritativeInformation | 業務結果碼,請查看后端服務日志。 |
1804 | 204 | BizNoContent | 業務結果碼,請查看后端服務日志。 |
1805 | 205 | BizResetContent | 業務結果碼,請查看后端服務日志。 |
1806 | 206 | BizPartialContent | 業務結果碼,請查看后端服務日志。 |
1807 | 207 | BizMultiStatus | 業務結果碼,請查看后端服務日志。 |
1808 | 208 | BizAlreadyReported | 業務結果碼,請查看后端服務日志。 |
1809 | 226 | BizIMUsed | 業務結果碼,請查看后端服務日志。 |
1999 | 200 | SuccessForHttpHealthCheck | HTTP 健康檢查響應。 |
2100 | 400 | RequestSignatureNotFound | 網關對沒有獲取到客戶端請求的簽名信息,請對請求加簽后再訪問網關。 |
2101 | 400 | RequestSignatureParseError | 網關對客戶端請求簽名解析失敗,請檢查客戶端生成的簽名。 |
2102 | 400 | RequestSignatureVerifyError | 網關對客戶端請求簽名校驗失敗,請檢查客戶端 AK、SK 是否設置正確。 |
2103 | 502 | RequestReSignatureError | 網關對服務端請求加簽失敗,請檢查加簽的算法類型是否支持,目前僅支持 SHA256 的算法。 |
2104 | 400 | ResponseSignatureVerifyError | 網關對服務端響應簽名校驗失敗,請檢查服務端 AK、SK 是否設置正確。 |
2105 | 400 | ResponseSignatureError | 網關對客戶端響應加簽失敗,請檢查加簽的算法類型是否支持,目前僅支持 SHA256 的算法。 |
2107 | 400 | ResponseSignatureParseError | 網關對服務端響應簽名解析失敗,請檢查服務端生成的簽名。 |
2108 | 400 | ResponseSignatureKeyIdNotMatch | 服務端返回的簽名中,AK 設置錯誤。 |
2109 | 502 | ServiceAkNotFound | 網關無法找到服務端 AK。 |
2110 | 502 | ServiceSkNotFound | 網關無法找到服務端 SK。 |
2111 | 400 | ResponseSignatureNotFoundError | 網關對沒有獲取到服務端請求的簽名信息,請對請求加簽后再返回響應。 |
2112 | 400 | ResponseDigestVerifyError | 網關對服務端響應摘要校驗失敗。 |
2113 | 403 | ClientAppKeyNotFound | 網關無法找到客戶端 AK。 |
2114 | 403 | ClientSecretKeyNotFound | 網關無法找到客戶端 SK。 |
2115 | 400 | RequestVerifyTsError | 網關對客戶端請求的時間戳校驗失敗,請檢查客戶端傳遞的時間戳是否已過期。 |
2116 | 400 | RequestVerifyDigestError | 網關對客戶端請求的時間戳校驗失敗,請檢查客戶端傳遞的時間戳是否已過期。 |
2300 | 403 | NoAccessForThisAppId | 該 API 未授權給當前發起請求的客戶端。 |
3000 | 400 | RouterNotFound | 網關不存在該 API。 |
3001 | 400 | RouterGroupNotFound | 網關不存在該 API。 |
3002 | 400 | NoSofaRpcRequestHeaderFound | SOFARPC 請求 header 缺失。 |
3003 | 400 | NoSofaRpcRequestHostFound | SOFARPC 請求 host 缺失。 |
3103 | 400 | NoAppFound | 沒有找到該 App,請確認客戶端設置的 AK 是否正確。 |
3104 | 400 | NoTenantFound | 沒有找到 App 的租戶信息。 |
3105 | 400 | NoWorkspaceFound | 沒有找到 App 的 workspace 信息。 |
3999 | 400 | BadRequest | 請求失敗,錯誤請求。 |
4000 | 400 | NoProxyServiceFound | 沒有找到目標服務,無法發起調用,請檢查系統集群的地址是否填寫正確。 |
4001 | 504 | InvokeServiceTimeout | 調用后端服務超時。 |
4002 | 502 | UnknownProxyError | 調用后端服務失敗,可能的原因有三種:
|
4003 | 502 | SofaResponseHeaderCodeConvertError | SOFARPC 返回碼解析失敗。 |
4010 | 406 | NoSofaRpcMethodFound | 沒有找到目標 SOFARPC 服務。 |
4011 | 406 | NoSofaRpcServiceFound | 沒有找到目標 SOFARPC 方法名。 |
4100 | 502 | SofaRpcResponseDecodeError | SOFARPC 響應解碼失敗。 |
4101 | 400 | SofaRpcRequestDecodeError | SSOFARPC 請求解碼失敗。 |
4200 | 502 | SetMockResponseError | Mock 響應設置失敗,請檢查 Mock 的格式。 |
4201 | 502 | MockResponseCodeConvertError | mock result-code 解析失敗,請檢查 result-code 是否為四位正整數。 |
4202 | 502 | MockResponseContentConvertError | Mock 響應解析失敗,請檢查 mock 的格式。 |
5000 | 502 | UnknownError | 未知異常 |
5001 | 502 | ContextNotFoundError | 網關異常,網關上下文丟失。 |
5002 | 502 | NoListenerConfigFound | 網關異常,沒有找到對應的端口配置,請聯系網關同學排查。 |
5003 | 502 | NoListenerInstanceFound | 網關異常,沒有找到對應的端口配置,請聯系網關同學排查。 |
5004 | 502 | NoDownProtocolSupport | 不支持的前端協議類型,目前公有云上網關僅支持前端協議為 HTTP 的請求。 |
5005 | 500 | InternalServerError | SOFARPC 響應 header 丟失。 |
5006 | 502 | SofaRpcCodecException | SOFARPC 服務端編解碼失敗。 |
5007 | 502 | SofaRpcCodecUnknownException | SOFARPC 服務端未知異常。 |
5008 | 502 | SofaRpcCodecDeserialException | SOFARPC 服務端反序列化異常。 |
5009 | 502 | SofaRpcCodecPermissionDenied | SOFARPC 服務端返回 403。 |
5010 | 502 | SofaRpcRouterUnavailable | SOFARPC 服務端返回 404。 |
5011 | 502 | SofaRpcNoHealthUpstream | SOFARPC 服務端返回 502。 |
5012 | 429 | SofaRpcUpstreamOverFlow | SOFARPC 服務端返回 503。 |
5013 | 504 | SofaRpcTimeout | SOFARPC 服務端返回 504。 |
5015 | 503 | SofaRpcLimitExceeded | SOFARPC 服務端返回 509。 |
5016 | 502 | ParseResultCodeError | SOFARPC 結果碼匹配異常。 |
5101 | 503 | RecursiveTooManyTime | 不允許多次循環調用網關。 |
5102 | 503 | RecursiveParseError | 循環調用請求解析失敗。 |
6000-6006 | 503 | MockResponseContentConvertError | Mock 響應設置失敗,請檢查 Mock 的格式。 |
6100 | 300 | BizMultipleChoices | 業務結果碼,請查看后端服務日志。 |
6101 | 301 | BizMovedPermanently | 業務結果碼,請查看后端服務日志。 |
6102 | 302 | BizFound | 業務結果碼,請查看后端服務日志。 |
6103 | 303 | BizSeeOther | 業務結果碼,請查看后端服務日志。 |
6104 | 304 | BizNotModified | 業務結果碼,請查看后端服務日志。 |
6105 | 305 | BizUseProxy | 業務結果碼,請查看后端服務日志。 |
6106 | 307 | BizTemporaryRedirect | 業務結果碼,請查看后端服務日志。 |
6107 | 308 | BizPermanentRedirect | 業務結果碼,請查看后端服務日志。 |
6201 | 400 | BizBadRequest | 業務結果碼,請查看后端服務日志。 |
6202 | 401 | BizUnauthorized | 業務結果碼,請查看后端服務日志。 |
6203 | 402 | BizPaymentRequired | 業務結果碼,請查看后端服務日志。 |
6204 | 403 | BizForbidden | 業務結果碼,請查看后端服務日志。 |
6205 | 404 | BizNotFound | 業務結果碼,請查看后端服務日志。 |
6206 | 405 | BizMethodNotAllowed | 業務結果碼,請查看后端服務日志。 |
6207 | 406 | BizNotAcceptable | 業務結果碼,請查看后端服務日志。 |
6208 | 407 | BizProxyAuthenticationRequired | 業務結果碼,請查看后端服務日志。 |
6209 | 408 | BizRequestTimeout | 業務結果碼,請查看后端服務日志。 |
6210 | 409 | BizConflict | 業務結果碼,請查看后端服務日志。 |
6211 | 410 | BizGone | 業務結果碼,請查看后端服務日志。 |
6212 | 411 | BizLengthRequired | 業務結果碼,請查看后端服務日志。 |
6213 | 412 | BizPreconditionFailed | 業務結果碼,請查看后端服務日志。 |
6214 | 413 | BizPayloadTooLarge | 業務結果碼,請查看后端服務日志。 |
6215 | 414 | BizURITooLong | 業務結果碼,請查看后端服務日志。 |
6216 | 415 | BizUnsupportedMediaType | 業務結果碼,請查看后端服務日志。 |
6217 | 416 | BizRangeNotSatisfiable | 業務結果碼,請查看后端服務日志。 |
6218 | 417 | BizExpectationFailed | 業務結果碼,請查看后端服務日志。 |
6219 | 421 | BizMisdirectedRequest | 業務結果碼,請查看后端服務日志。 |
6220 | 422 | BizUnprocessableEntity | 業務結果碼,請查看后端服務日志。 |
6221 | 423 | BizLocked | 業務結果碼,請查看后端服務日志。 |
6222 | 424 | BizFailedDependency | 業務結果碼,請查看后端服務日志。 |
6223 | 426 | BizUpgradeRequired | 業務結果碼,請查看后端服務日志。 |
6224 | 428 | BizPreconditionRequired | 業務結果碼,請查看后端服務日志。 |
6225 | 429 | BizTooManyRequests | 業務結果碼,請查看后端服務日志。 |
6226 | 431 | BizRequestHeaderFieldsTooLarge | 業務結果碼,請查看后端服務日志。 |
6301 | 500 | BizInternalServerError | 業務結果碼,請查看后端服務日志。 |
6302 | 501 | BizNotImplemented | 業務結果碼,請查看后端服務日志。 |
6303 | 502 | BizBadGateway | 端口不可用或者序列化有問題。 |
6304 | 503 | BizServiceUnavailable | 業務結果碼,請查看后端服務日志。 |
6305 | 504 | BizGatewayTimeout | 業務結果碼,請查看后端服務日志。 |
6306 | 505 | BizHTTPVersionNotSupported | 業務結果碼,請查看后端服務日志。 |
6307 | 506 | BizVariantAlsoNegotiates | 業務結果碼,請查看后端服務日志。 |
6308 | 507 | BizInsufficientStorage | 業務結果碼,請查看后端服務日志。 |
6309 | 508 | BizLoopDetected | 業務結果碼,請查看后端服務日志。 |
6310 | 510 | BizNotExtended | 業務結果碼,請查看后端服務日志。 |
6311 | 511 | BizNetworkAuthenticationRequiredMultipleChoices | 業務結果碼,請查看后端服務日志。 |
6666 | 503 | MockResponseContentConvertError | Mock 響應設置失敗,請檢查 Mock 的格式。 |
7001 | 503 | DecryptionFailed | 解密失敗,請檢查客戶端和服務端加密狀態、以及密鑰信息、密鑰類型是否匹配。 |
7002 | 503 | EncryptionFailed | 加密失敗,請檢查客戶端和服務端加密狀態、以及密鑰信息、密鑰類型是否正確。 |
7006 | 503 | GzipError | 壓縮失敗。 |
7007 | 503 | UnGzipError | 解壓失敗,請檢查壓縮數據格式、及公私密鑰是否匹配。 |
7300 | 400 | RemoteAuthFail | 外部授權失敗。 |
7301 | 502 | RemoteAuthError | 外部授權異常。 |
7777 | 502 | UnknownFilterError | 未知的過濾條件執行異常。 |
7900 | 502 | RequestParamExpressionParseError | 請求參數映射表達式解析失敗。 |
7901 | 502 | RequestParamParseError | 請求參數解析失敗。 |
7902 | 502 | RequestParamRenderError | 請求參數渲染失敗。 |
7903 | 502 | ResponseParamExpressionParseError | 響應參數映射表達式解析失敗。 |
7904 | 502 | ResponseParamParseError | 響應參數解析失敗。 |
7905 | 502 | ResponseParamRenderError | 響應參數渲染失敗。 |
8002 | 200 | CorsSuccess | 跨域資源共享訪問成功。 |
8003 | 200 | CorsError | cors response |
8101 | 403 | AccessControlForbidden | 被訪問控制系統攔截,不允許的請求。 |
8200 | 502 | NoLdcLdcConfigFound | LDC 配置丟棄,請重新提交 LDC 路由設置。 |
8201 | 403 | NoLdcUidFound | LDC 請求缺少 uid,請在 LDC 路由規則中配置 uid 路由參數。 |
8202 | 403 | LdcUidIsTooShort | uid 長度太短,無法進行截取操作。 |