Error Codes

No data will be returned if an API fails to be called. You can locate the error cause based on the error code of each API. When an API call fails, HTTPS status code 4xx or 5xx is returned. The returned message body contains the specific error code and error information. If you fail to locate the cause of the error, contact technical support and provide the error code for troubleshooting.

Error Response Body Format

If an error occurs during API calling, an error code and error message will be displayed. An error response body is shown as follows:

{
    "error_msg": "The input parameter is invalid.",
    "error_code": "AIS.0101"
}

In the error response, error_code indicates an error code, and error_msg describes the error.

Error Codes

Category

Error Code

Error Message

Description

Solution

OCR

AIS.0101

The input parameter is invalid.

The input parameter does not meet the requirements.

Check whether the input parameters are correct. Possible causes are as follows:

  • Both image and url set, or the value format is incorrect.

  • true or false is incorrectly spelled.

  • Incorrect characters are included in the parameter value.

For details about the parameter value format, see the request parameter description of each API.

AIS.0102

The image format is not supported.

The image format is not supported.

Check the image format. For details about the image format supported by each service, see "Constraints and Limitations" in the related API section.

AIS.0103

The image size does not meet the requirements.

The image size does not meet the requirements.

Check the image size. For details about the image size supported by each service, see "Constraints and Limitations" in the related API section.

AIS.0104

The image is not supported or the image quality is poor.

The image is not supported or is of poor quality.

Check the image type and quality.

Check whether the called API is correct.

AIS.0105

Recognition failed.

Algorithm calculation failed.

Contact technical support.

Platform

ModelArts.0203

Invalid token.

Invalid token.

Ensure that the token is correct.

ModelArts.4101

Token header cannot be empty.

The token is empty.

The HTTP request header does not contain the token request authentication information of x-auth-token. Check the request.

ModelArts.4102

Parse Token error.

Failed to parse the token.

The token request authentication information of x-auth-token in the HTTP request header is incorrect. Check the sent request and token.

ModelArts.4103

Invalid Token header.

The token is invalid.

The token request authentication information of x-auth-token in the HTTP request header is incorrect. Check the sent request and token.

ModelArts.4104

Invalid Request Content Length.

The length of the request body is invalid.

Check the request body length. The size cannot exceed 10 MB.

ModelArts.4105

The JSON format of the input data is incorrect.

The JSON format of the request body is incorrect.

Check the JSON format of the request body.

ModelArts.4201

Request url need service id.

The request URL does not contain the service ID.

Check the service ID in the request URL.

ModelArts.4202

Request url format invalid.

The request URL format is invalid.

Check the request URL format.

ModelArts.4203

Access denied! You do not have permission.

No access permission.

Check the access permission.

ModelArts.4204

Request api error! The API XXX is not subscribed.

Failed to request the service because the service has not been subscribed.

  • Go to the OCR console, select an appropriate region, and subscribe to the API you need.

  • If the service has been subscribed to, check whether the region (or account) where the service is subscribed to is the same as the region (or account) where the service is called. If they are the same, check whether the URL of the API is spelled correctly.

ModelArts.4301

Have error when get ai-service admin token.

Failed to obtain the admin token of the service.

Contact technical support.

ModelArts.4302

Gateway forwarding error.

The serviced failed to be accessed.

Contact technical support.

ModelArts.4401

Max concurrency error.

The number of concurrent requests exceeds the upper limit.

Contact technical support.

ModelArts.4402

Backend service timeout error.

Service processing timed out.

Contact technical support.

ModelArts.4403

Backend service unavailable error.

The service is unavailable because it failed to respond or its failure rate is high.

Contact technical support.

ModelArts.4502

Backend service response error.

The service failed to respond.

Contact technical support.

ModelArts.4503

Backend service found error.

The service does not exist.

Contact technical support.

ModelArts.4504

Backend service api not found.

The API to be accessed does not exist.

Contact technical support.

ModelArts.4505

Backend service internal error.

Internal server error.

Contact technical support.

ModelArts.4506

SubService service found error.

The subservice corresponding to the API does not exist.

Contact technical support.

ModelArts.4508

Service not start.

The service does not exist or is stopped.

Contact technical support.

ModelArts.4601

The URL is not allowed.

The external URL is invalid.

Check the format of the entered download address.

ModelArts.4603

Obtaining the file from the URL failed.

Failed to download files from the external URL.

Check the network and URL.

ModelArts.4702

Query Obs agency failed.

Failed to query the OBS agency.

Check whether the OBS agency has been enabled for the service.

ModelArts.4703

The Obs URL is invalid.

The OBS URL is invalid.

Check the OBS URL.

ModelArts.4704

Obtaining the file from the OBS failed.

The OBS file failed to be obtained.

Check the OBS file.

ModelArts.4705

The file stored on the OBS is oversized.

The OBS file is oversized.

Check the size of the OBS file and ensure that the file does not exceed the size limit.

ModelArts.4706

The Obs file is not exist.

The OBS file does not exist.

Check whether the corresponding file exists.

APIG

APIG.0101

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

The API does not exist or has not been published.

  • Check whether the API URL is correct. For example, check whether the project ID is included in the URL.

  • Check whether the region in the URI is the same as that configured for calling the service by referring to Endpoint.

  • Check whether the HTTP request method (such as POST and GET) is correct.

  • For details about the URI, see the corresponding API page.

APIG.0201

Backend timeout.

Request timed out.

  • Check whether the original API call requests are excessively frequent. If so, check the return value in the code and resend the requests later (for example, 2 to 5 seconds later). You can also check whether the result of the previous request is returned at the backend. After the result of the previous request is returned, send the next request.

  • Check whether the image is too large or the network delay is too long. If the image is too large, compress the image in proportion while ensuring the image definition. If the network delay is long, you can increase the network transmission speed.

APIG.0301

Incorrect IAM authentication information.

The IAM authentication information is incorrect.

  • decrypt token fail: The token fails to be parsed.

  • token expires: The token has expired.

  • x-auth-token not found: The x-auth-token parameter is not found.

  • If the token fails to be parsed, check the method for obtaining the token, whether the request body is correct, whether the token is correct, and whether the environment for obtaining the token is the same as the environment for calling the token.

  • If the token expires, obtain a new token that is valid permanently.

  • Check whether the spelling of X-Auth-Token in the request header is correct.

APIG.0308

The throttling threshold has been reached: policy user over ratelimit,limit:XX,time:1 minute.

The request exceeds the default rate limit of the service.

Rectify the fault using either of the following methods:

  • Use the retry mechanism to rectify the fault by checking the return value in the code and retrying the requests after a short period of time (for example, 2 to 5 seconds).

  • You can also check whether the result of the previous request is returned at the backend. After the result of the previous request is returned, send the next request.

Other

If other error codes cannot be rectified, contact technical support.

last updated: 2024-12-11 10:02 UTC - commit: f18a89e157ed002602c57458c4d33037c98e13a9