Updated on 2024-10-09 GMT+08:00

Error Codes

The following table lists the error codes that you may encounter when calling APIs. If an error code starting with APIGW is returned after you call an API, rectify the fault by referring to the instructions provided in section "Error Codes" in the API Request Signing Guide.

  • For details about the error codes that may occur when you manage APIs, see section "Error Codes" in the API Gateway API Reference.
  • If an error occurs when you use APIG, find the error message and description in the following table according to the error code, for example, APIG.0101. The error messages are subject to change without prior notice.
Table 1 Error codes

Error Code

Error Message

HTTP Status Code

Description

Solution

APIG.0101

The API does not exist or has not been published in the environment.

404

The API does not exist or has not been published in the environment.

Check whether the domain name, method, and path are consistent with those of the created API. Check whether the API has been published. If it has been published in a non-production environment, check whether the X-Stage header in the request is the environment name. Check whether the domain name used to call the API has been bound to the group to which the API belongs.

APIG.0101

The API does not exist.

404

The API request method does not exist.

Check whether the API request method is the same as the method defined by the API.

APIG.0103

The backend does not exist.

500

The backend service was not found.

Contact technical support.

APIG.0104

The plug-ins do not exist.

500

No plug-in configurations were found.

Contact technical support.

APIG.0105

The backend configurations do not exist.

500

No backend configurations were found.

Contact technical support.

APIG.0106

Orchestration error.

400

An orchestration error occurred.

Check whether the frontend and backend parameters of the API are correct.

APIG.0107

The custom lua script encountered an unexpected error

500

An unknown error occurred in the Lua script.

Contact technical support.

APIG.0201

API request error.

400

Invalid request parameters.

Set valid request parameters.

APIG.0201

Request entity too large.

413

The request body exceeds 12 MB.

Reduce the size of the request body.

APIG.0201

Request URI too large.

414

The request URI exceeds 32 KB.

Reduce the size of the request URI.

APIG.0201

Request headers too large.

494

The request headers are too large because one of them exceeds 32 KB or the total length exceeds 128 KB.

Reduce the size of the request headers.

APIG.0201

Backend unavailable.

502

The backend service is unavailable.

Check whether the backend address configured for the API is accessible.

APIG.0201

Backend timeout.

504

The backend service has timed out.

Increase the timeout duration of the backend service or shorten the processing time.

APIG.0201

An unexpected error occurred

500

An internal error occurred.

Contact technical support.

APIG.0202

Backend unavailable

502

The backend is unavailable.

Check whether the backend request protocol configured for the API is the same as the request protocol used by the backend service.

APIG.0203

Backend timeout

504

The backend service has timed out.

Increase the timeout duration of the backend service or shorten the processing time.

APIG.0204

SSL protocol is not supported: TLSv1.1

400

The SSL protocol version is not supported.

Use a supported SSL protocol version.

APIG.0205

Verify client certificate failed

400

Failed to verify the client certificate.

Check whether the client certificate is correct.

APIG.0301

Incorrect IAM authentication information.

401

The IAM authentication details are incorrect.

Check whether the token is correct.

APIG.0302

The IAM user is not authorized to access the API.

403

The IAM user is not allowed to access the API.

Check whether the user is controlled by a blacklist or whitelist.

APIG.0303

Incorrect app authentication information.

401

The app authentication details are incorrect.

Check whether the request method, path, query strings, and request body are consistent with those used for signing; check whether the date and time on the client are correct; and check whether the signing code is correct by referring to section "Calling APIs Through App Authentication" of the Developer Guide.

APIG.0304

The app is not authorized to access the API.

403

The app is not allowed to access the API.

Check whether the app has been authorized to access the API.

APIG.0305

Incorrect authentication information.

401

The authentication information is incorrect.

Check whether the authentication information is correct.

APIG.0306

API access denied.

403

Access to the API is not allowed.

Check whether you have been authorized to access the API.

APIG.0307

The token must be updated.

401

The token needs to be updated.

Obtain a new token from IAM.

APIG.0308

The throttling threshold has been reached.

429

The throttling threshold has been reached.

Try again after the throttling resumes. If the number of debugging domain requests per day is reached, bind an independent domain name to the service to which the API belongs.

APIG.0310

The project is unavailable.

403

The project is currently unavailable.

Select another project and try again.

APIG.0311

Incorrect debugging authentication information.

401

The debugging authentication details are incorrect.

Contact technical support.

APIG.0312

Incorrect third-party authentication information,auth fail

401

The authentication failed because the third-party authentication information is incorrect.

Check whether the identity information is correct.

APIG.0313

Incorrect third-party authentication information,identities error

401

The identity included in the third-party authentication information is incorrect.

Check whether the identity information is consistent with the identity source in the third-party authentication plug-in.

APIG.0314

Incorrect third-party authentication information,access deny

403

Access denied because the third-party authentication information is incorrect.

Contact technical support to check whether the request is a service request. If yes, increase the brute force threshold of the third-party authentication plug-in.

APIG.0401

Unknown client IP address.

403

The client IP address cannot be identified.

Contact technical support.

APIG.0402

The IP address is not authorized to access the API.

403

The IP address is not allowed to access the API.

Check whether the IP address is controlled by a blacklist or whitelist.

APIG.0404

Access to the backend IP address has been denied.

403

The backend IP address cannot be accessed.

Check whether the backend IP address or the IP address corresponding to the backend domain name is accessible.

APIG.0405

The app is not accessed from a trusted IP address.

403

The application is not accessed from a trusted IP address.

Check whether the source IP address is allowed or denied in the access control policy.

APIG.0501

The app quota has been used up.

405

The app quota has been reached.

Increase the app quota.

APIG.0502

The app has been frozen.

405

The app has been frozen.

Check whether your account balance is sufficient.

APIG.0601

Internal server error.

500

An internal error occurred.

Contact technical support.

APIG.0602

Bad request.

400

Invalid request.

Check whether the request is valid.

APIG.0605

Domain name resolution failed.

500

Domain name resolution failed.

Check whether the domain name is correct and has been bound to a correct backend address.

APIG.0606

Failed to load the API configurations.

500

API configurations could not be loaded.

Contact technical support.

APIG.0607

The following protocol is supported: {xxx}

400

The protocol is not supported. Only xxx is supported.

xxx is subject to the actual value in the response.

Use HTTP or HTTPS to access the API.

APIG.0608

Failed to obtain the admin token.

500

The administrator account details cannot be obtained.

Contact technical support.

APIG.0609

The VPC backend does not exist.

500

The workload backend service cannot be found.

Contact technical support.

APIG.0610

No backend available.

502

No backend services are available.

Check whether all backend services are available. For example, check whether the API calling information is consistent with the actual configuration.

APIG.0611

The backend port does not exist.

500

The backend port was not found.

Contact technical support.

APIG.0612

An API cannot call itself.

500

An API cannot call itself.

Modify the backend configurations, and ensure that the number of layers the API is recursively called does not exceed 10.

APIG.0613

The IAM service is currently unavailable.

503

IAM is currently unavailable.

Contact technical support.

APIG.0615

Incorrect third-party authentication VPC information

500

Failed to obtain the load balance channel nodes for third-party authentication.

Check whether the load balance channel for third-party authentication is correctly configured.

APIG.0616

Incorrect third-party authentication request information

500

Failed to connect to the third-party authentication service.

Check whether the third-party authentication service is normal.

APIG.0617

Incorrect third-party authentication response information

500

Failed to obtain response from the third-party authentication service.

Check whether the third-party authentication service is normal.

APIG.0705

Backend signature calculation failed.

500

Backend signature calculation failed.

Contact technical support.

APIG.0802

The IAM user is forbidden in the currently selected region

403

The IAM user is disabled in the current region.

Contact technical support.

APIG.2102

PublicKey is null

400

The signature key is not found.

Contact technical support.

APIG.2201

Appkey or SecretKey is invalid

400

Invalid AppKey or SecretKey.

Check whether the AppKey and SecretKey in the request are correct.

APIG.2202

Refresh token is invalid

400

Invalid refresh token.

Check whether the refresh token is correct.

APIG.2203

Access token is invalid

400

Invalid access token.

Check whether the access token is correct.

APIG.2204

ContentType invalid

400

Invalid ContentType.

Check whether the ContentType is correct.

APIG.2205

Auth parameter invalid

400

Invalid authentication parameter.

Check whether the authentication parameters are correct.

APIG.2206

Auth method invalid

400

Invalid authentication mode.

Check whether the authentication mode is correct.

APIG.2208

The length of through_data is out of range

400

The length of through_data is out of range.

The maximum length of through_data is 300. Adjust through_data based on the actual situation.

APIG.2209

The value of grant_type is not in enum List

400

The value of grant_type is invalid.

The value of grant_type can only be client_credentials or refresh_token. Change it based on the actual situation.

APIG.2210

Lack of grant_type

400

The authorization type is missing.

Add grant_type.

APIG.2211

Lack of client_id

400

The client ID is missing.

Add a client ID.

APIG.2212

Lack of client_secret

400

The client secret is missing.

Add a client secret.

APIG.2213

Lack of refresh_token

400

The refresh token is missing.

Contact technical support.

APIG.1001

Refresh token is expired

401

The refresh token has expired.

Obtain another refresh token.

APIG.1002

Access token is expired

401

The access token has expired.

Obtain another access token.

APIG.1003

App not match refresh token

401

The app does not match the refresh token.

Check whether the client_id is correct.

APIG.1004

App not exist

401

The app does not exist.

Check whether the access token is correct.

APIG.1009

AppKey or AppSecret is invalid

400

The AppKey or AppSecret is invalid.

Check whether the AppKey or AppSecret in the request is correct.