SOFAStack API统一网关有哪些错误码_SOFAStack API 统一网关(Sofa Apigateway)-阿里云帮助中心

为方便您在使用过程中进行问题定位，本文将介绍网关的错误码信息。

简介

网关提供了错误码及相关解决方案。一个错误码的完整信息包括结果码、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	调用后端服务失败，可能的原因有三种： RPC 序列化有问题网络不通被 IP 安全策略拦截
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 长度太短，无法进行截取操作。