Error codes-SOFAStack APIGateway(Sofa Apigateway)-阿里云帮助中心

This topic describes gateway error codes to help you troubleshoot issues.

Introduction

The gateway provides error codes and related solutions. The complete information for an error code consists of a result code, an HTTP status code, a memo, and tips.

The result code is a return code defined by the gateway that identifies the response status of a request.
Each result code corresponds to a standard HTTP status code.
The memo describes the result indicated by the result code.
The tips provide an explanation for the result code.

Common error codes

Abnormal API requests

The following table lists common error codes for abnormal API requests:

Result code	HTTP status code	Result information (memo)	Description (tips)
3000	400	RouterNotFound	The API does not exist in the gateway.
3001	400	RouterGroupNotFound	The API group does not exist in the gateway.

Note

Abnormal API requests can occur if the console has not delivered the configuration or the gateway has not yet updated the configuration.

Troubleshoot as follows:

You can check that the corresponding API is configured in the gateway and that the API status is Published.
You can check if the API call path, group, and other information on the client are consistent with the information configured in the gateway.
You can check if the host, path, and method of the request are correct.

Signature or signature verification failure

The following table lists common error codes for failed signature or signature verification operations on the gateway:

Gateway result code	HTTP status code	Result information (memo)	Description (tips)
2100	400	RequestSignatureNotFound	The gateway did not obtain the signature information from the client request.
2102	400	RequestSignatureVerifyError	The gateway failed to verify the signature of the client request.
2103	502	RequestReSignatureError	The gateway failed to sign the server-side request.
2104	400	ResponseSignatureVerifyError	The gateway failed to verify the signature of the server-side response.

Troubleshoot as follows:

You can check if the client's AccessKey ID (AK) and AccessKey secret (SK) are configured correctly.
Note
You can disable security authentication for the API or the backend system cluster to test whether the call is successful. If the call succeeds, the issue is related to the signature or signature verification. Then, you can add the AK and SK to confirm that the call is still successful.
You can check if the signature algorithm is supported. Currently, only the SHA256 algorithm is supported.

All error codes

Gateway result code	HTTP status code	Result information (memo)	Description (tips)
1000	200	success	Request successful.
1002	429	TooManyRequests	The request was throttled by the gateway. Go to the API product page > Traffic Governance to view and adjust the throttling conditions.
1100	200	DefaultMockStatus	Returns a mock response.
1800	100	BizHttpContinue	Business result code. Check the backend service log.
1801	201	BizCreated	Business result code. Check the backend service log.
1802	202	BizAccepted	Business result code. Check the backend service log.
1803	203	BizNonAuthoritativeInformation	Business result code. Check the backend service log.
1804	204	BizNoContent	Business result code. Check the backend service log.
1805	205	BizResetContent	Business result code. Check the backend service log.
1806	206	BizPartialContent	Business result code. Check the backend service log.
1807	207	BizMultiStatus	Business result code. Check the backend service log.
1808	208	BizAlreadyReported	Business result code. Check the backend service log.
1809	226	BizIMUsed	Business result code. Check the backend service log.
1999	200	SuccessForHttpHealthCheck	HTTP health check response.
2100	400	RequestSignatureNotFound	The gateway did not obtain the signature information from the client request. Sign the request before accessing the gateway.
2101	400	RequestSignatureParseError	The gateway failed to parse the signature of the client request. Check the signature generated by the client.
2102	400	RequestSignatureVerifyError	The gateway failed to verify the signature of the client request. Check if the client AK and SK are set correctly.
2103	502	RequestReSignatureError	The gateway failed to sign the server-side request. Check if the signature algorithm is supported. Currently, only the SHA256 algorithm is supported.
2104	400	ResponseSignatureVerifyError	The gateway failed to verify the signature of the server-side response. Check if the server-side AK and SK are set correctly.
2105	400	ResponseSignatureError	The gateway failed to sign the client response. Check if the signature algorithm is supported. Currently, only the SHA256 algorithm is supported.
2107	400	ResponseSignatureParseError	The gateway failed to parse the signature of the server-side response. Check the signature generated by the server-side.
2108	400	ResponseSignatureKeyIdNotMatch	The AK is set incorrectly in the signature returned by the server-side.
2109	502	ServiceAkNotFound	The gateway cannot find the server-side AK.
2110	502	ServiceSkNotFound	The gateway cannot find the server-side SK.
2111	400	ResponseSignatureNotFoundError	The gateway did not obtain the signature information from the server-side request. Sign the request before returning a response.
2112	400	ResponseDigestVerifyError	The gateway failed to verify the summary of the server-side response.
2113	403	ClientAppKeyNotFound	The gateway cannot find the client AK.
2114	403	ClientSecretKeyNotFound	The gateway cannot find the client SK.
2115	400	RequestVerifyTsError	The gateway failed to verify the timestamp of the client request. Check if the timestamp sent by the client has expired.
2116	400	RequestVerifyDigestError	The gateway failed to verify the timestamp of the client request. Check if the timestamp sent by the client has expired.
2300	403	NoAccessForThisAppId	The API is not authorized for the client that initiated the request.
3000	400	RouterNotFound	The API does not exist in the gateway.
3001	400	RouterGroupNotFound	The API is not found in the gateway.
3002	400	NoSofaRpcRequestHeaderFound	The SOFARPC request header is missing.
3003	400	NoSofaRpcRequestHostFound	The SOFARPC request host is missing.
3103	400	NoAppFound	The app was not found. Confirm that the AK set by the client is correct.
3104	400	NoTenantFound	The tenant information for the app was not found.
3105	400	NoWorkspaceFound	The workspace information for the app was not found.
3999	400	BadRequest	Request failed. Bad request.
4000	400	NoProxyServiceFound	The destination service was not found and the call cannot be initiated. Check if the system cluster address is correct.
4001	504	InvokeServiceTimeout	The call to the backend service timed out.
4002	502	UnknownProxyError	Failed to call the backend service. There are three possible reasons: An issue with RPC serialization. Network is unreachable. Blocked by an IP security policy.
4003	502	SofaResponseHeaderCodeConvertError	Failed to parse the SOFARPC return code.
4010	406	NoSofaRpcMethodFound	The destination SOFARPC service was not found.
4011	406	NoSofaRpcServiceFound	The destination SOFARPC method name was not found.
4100	502	SofaRpcResponseDecodeError	Failed to decode the SOFARPC response.
4101	400	SofaRpcRequestDecodeError	Failed to decode the SOFARPC request.
4200	502	SetMockResponseError	Failed to set the mock response. Check the mock format.
4201	502	MockResponseCodeConvertError	Failed to parse the mock result-code. Check if the result-code is a four-digit positive integer.
4202	502	MockResponseContentConvertError	Failed to parse the mock response. Check the mock format.
5000	502	UnknownError	Unknown exception
5001	502	ContextNotFoundError	Gateway exception. The gateway context was lost.
5002	502	NoListenerConfigFound	Gateway exception. The corresponding port configuration was not found. Contact gateway personnel to troubleshoot.
5003	502	NoListenerInstanceFound	Gateway exception. The corresponding port configuration was not found. Contact gateway personnel to troubleshoot.
5004	502	NoDownProtocolSupport	The frontend protocol type is not supported. Currently, the gateway on the public cloud only supports requests with HTTP as the frontend protocol.
5005	500	InternalServerError	The SOFARPC response header is missing.
5006	502	SofaRpcCodecException	SOFARPC server-side encoding/decoding failed.
5007	502	SofaRpcCodecUnknownException	SOFARPC server-side unknown exception.
5008	502	SofaRpcCodecDeserialException	SOFARPC server-side deserialization exception.
5009	502	SofaRpcCodecPermissionDenied	SOFARPC server-side returned 403.
5010	502	SofaRpcRouterUnavailable	SOFARPC server-side returned 404.
5011	502	SofaRpcNoHealthUpstream	SOFARPC server-side returned 502.
5012	429	SofaRpcUpstreamOverFlow	SOFARPC server-side returned 503.
5013	504	SofaRpcTimeout	SOFARPC server-side returned 504.
5015	503	SofaRpcLimitExceeded	SOFARPC server-side returned 509.
5016	502	ParseResultCodeError	SOFARPC result code matching exception.
5101	503	RecursiveTooManyTime	The gateway cannot be called recursively multiple times.
5102	503	RecursiveParseError	Failed to parse the recursive invocation request.
6000-6006	503	MockResponseContentConvertError	Failed to set the mock response. Check the mock format.
6100	300	BizMultipleChoices	Business result code. Check the backend service log.
6101	301	BizMovedPermanently	Business result code. Check the backend service log.
6102	302	BizFound	Business result code. Check the backend service log.
6103	303	BizSeeOther	Business result code. Check the backend service log.
6104	304	BizNotModified	Business result code. Check the backend service log.
6105	305	BizUseProxy	Business result code. Check the backend service log.
6106	307	BizTemporaryRedirect	Business result code. Check the backend service log.
6107	308	BizPermanentRedirect	Business result code. Check the backend service log.
6201	400	BizBadRequest	Business result code. Check the backend service log.
6202	401	BizUnauthorized	Business result code. Check the backend service log.
6203	402	BizPaymentRequired	Business result code. Check the backend service log.
6204	403	BizForbidden	Business result code. Check the backend service log.
6205	404	BizNotFound	Business result code. Check the backend service log.
6206	405	BizMethodNotAllowed	Business result code. Check the backend service log.
6207	406	BizNotAcceptable	Business result code. Check the backend service log.
6208	407	BizProxyAuthenticationRequired	Business result code. Check the backend service log.
6209	408	BizRequestTimeout	Business result code. Check the backend service log.
6210	409	BizConflict	Business result code. Check the backend service log.
6211	410	BizGone	Business result code. Check the backend service log.
6212	411	BizLengthRequired	Business result code. Check the backend service log.
6213	412	BizPreconditionFailed	Business result code. Check the backend service log.
6214	413	BizPayloadTooLarge	Business result code. Check the backend service log.
6215	414	BizURITooLong	Business result code. Check the backend service log.
6216	415	BizUnsupportedMediaType	Business result code. Check the backend service log.
6217	416	BizRangeNotSatisfiable	Business result code. Check the backend service log.
6218	417	BizExpectationFailed	Business result code. Check the backend service log.
6219	421	BizMisdirectedRequest	Business result code. Check the backend service log.
6220	422	BizUnprocessableEntity	Business result code. Check the backend service log.
6221	423	BizLocked	Business result code. Check the backend service log.
6222	424	BizFailedDependency	Business result code. Check the backend service log.
6223	426	BizUpgradeRequired	Business result code. Check the backend service log.
6224	428	BizPreconditionRequired	Business result code. Check the backend service log.
6225	429	BizTooManyRequests	Business result code. Check the backend service log.
6226	431	BizRequestHeaderFieldsTooLarge	Business result code. Check the backend service log.
6301	500	BizInternalServerError	Business result code. Check the backend service log.
6302	501	BizNotImplemented	Business result code. Check the backend service log.
6303	502	BizBadGateway	The port is unavailable or there is an issue with serialization.
6304	503	BizServiceUnavailable	Business result code. Check the backend service log.
6305	504	BizGatewayTimeout	Business result code. Check the backend service log.
6306	505	BizHTTPVersionNotSupported	Business result code. Check the backend service log.
6307	506	BizVariantAlsoNegotiates	Business result code. Check the backend service log.
6308	507	BizInsufficientStorage	Business result code. Check the backend service log.
6309	508	BizLoopDetected	Business result code. Check the backend service log.
6310	510	BizNotExtended	Business result code. Check the backend service log.
6311	511	BizNetworkAuthenticationRequiredMultipleChoices	Business result code. Check the backend service log.
6666	503	MockResponseContentConvertError	Failed to set the mock response. Check the mock format.
7001	503	DecryptionFailed	Decryption failed. Check if the encryption status, key information, and key type match between the client and the server-side.
7002	503	EncryptionFailed	Encryption failed. Check if the encryption status, key information, and key type are correct for the client and the server-side.
7006	503	GzipError	Compression failed.
7007	503	UnGzipError	Decompression failed. Check if the compressed data format and the public/private keys match.
7300	400	RemoteAuthFail	External authorization failed.
7301	502	RemoteAuthError	External authorization exception.
7777	502	UnknownFilterError	An unknown filter condition caused an execution exception.
7900	502	RequestParamExpressionParseError	Failed to parse the request parameter mapping expression.
7901	502	RequestParamParseError	Failed to parse the request parameter.
7902	502	RequestParamRenderError	Failed to render the request parameter.
7903	502	ResponseParamExpressionParseError	Failed to parse the response parameter mapping expression.
7904	502	ResponseParamParseError	Failed to parse the response parameter.
7905	502	ResponseParamRenderError	Failed to render the response parameter.
8002	200	CorsSuccess	Cross-origin resource sharing access successful.
8003	200	CorsError	CORS response
8101	403	AccessControlForbidden	The request was blocked by the Resource Access Management system. The request is not allowed.
8200	502	NoLdcLdcConfigFound	The LDC configuration was discarded. Resubmit the LDC routing settings.
8201	403	NoLdcUidFound	The LDC request is missing a uid. Configure the uid routing parameter in the LDC routing rule.
8202	403	LdcUidIsTooShort	The uid is too short to be truncated.