Error codes for management and control API operations
Learn about the error codes that may be returned when you call management and control API operations.
When you call API Gateway operations such as CreateAPI, ModifyAPI, and DeleteAPI, the following error codes may be returned.
Server error codes
A 5XX HTTP status code indicates that the service is unavailable. Retry the request later.
|
Error code |
Description |
HTTP status code |
Description |
Solution |
|
ServiceUnavailable |
The request has failed due to a temporary failure of the server. |
503 |
The error message returned because the service is unavailable. |
Try again later. |
|
InternalError |
The request processing has failed due to some unknown error, exception or failure. |
500 |
The error code returned because an internal error occurs. |
Try again later. |
Client error codes
A 4XX HTTP status code indicates a client-side error, such as an invalid parameter, an access control violation, or a business logic failure. Review the error details to troubleshoot the issue.
|
Error code |
Description |
HTTP status code |
Description |
Solution |
|
Repeated%s |
The specified %s is repeated. |
400 |
The error message returned because the value of a parameter has been used. %s in the message is a placeholder that indicates a parameter name. |
Change the parameter value and try again. |
|
RepeatedCommit |
Resubmit request. |
400 |
The error message returned because the request has been submitted. |
Do not repeatedly submit the same request. |
|
Missing%s |
The %s is mandatory for this action. |
400 |
The error message returned because the %s parameter is not specified. |
Specify the %s parameter based on the error description and try again. |
|
MissingAppIdOrAppOwner |
AppId or AppOwner must have a valid value. |
400 |
The error message returned because the AppId or AppOwner parameter is not specified. |
Specify the AppId or AppOwner parameter, or both of them. |
|
Invalid%s |
The specified parameter %s value is not valid. |
400 |
The error message returned because the specified parameter is invalid. |
View the requirements on the specified parameter, modify the parameter, and then try again. |
|
NotFound%s |
Cannot find resource according to your specified %s. |
400 |
The error message returned because no resource can be found based on the value of the %s parameter. |
Check whether the %s parameter is correctly specified. |
|
InvalidFormat%s |
The specified parameter %s value is not well formatted. |
400 |
The error message returned because the parameter format is invalid. |
View the requirements on the format of the value of the %s parameter, modify the parameter value, and then try again. |
|
Duplicate%s |
The specified parameter %s value is duplicate. |
400 |
The error message returned because the value of the %s parameter has been used. |
Change the parameter value and try again. |
|
DependencyViolation%s |
The specified %s has %s definitions. |
400 |
The error message returned because the parameter dependency is invalid. |
Remove the dependency. A parameter on which other parameters depend cannot be deleted. To delete such a parameter, remove the dependency first. |
|
Forbidden%s |
Not allowed to operate on the specified %s. |
403 |
The error message returned because you are not allowed to perform the operation. |
Obtain the permission to perform the operation. |
|
NoPermission |
User is not authorized to operate on the specified resource. |
403 |
The error message returned because you are not authorized to perform operations on the specified resource. |
Obtain the permissions to perform operations on the specified resource. |
|
ExceedLimit%s |
The specified %s count exceeds the limit. |
400 |
The error message returned because the number of APIs, API groups, or applications created within your Alibaba Cloud account exceeds the quota. |
Modify the quota of APIs, API groups, or applications. |
|
UserNotFound |
The specified user can not be found. |
404 |
The error message returned because the specified user does not exist. |
Enter valid information about the user. |
|
DomainCertificateNotFound |
Cannot find the domain certificate. |
400 |
The error message returned because the certificate for the specified domain name does not exist. |
Check the ID and name of the uploaded certificate. |
|
DomainNotResolved |
The specified domain has not been resolved. |
400 |
The error message returned because the specified domain name is not resolved. |
Bind a specific CNAME record to the second-level domain name of the API group. Domain name resolution is performed by the domain name registrar from which you purchase the domain name. |
|
InvalidICPLicense |
The specified domain have not got ICP license, or the ICP license does not belong to Aliyun. |
400 |
The error message returned because the Internet Content Provider (ICP) filing for the specified domain name is invalid. |
Apply for an ICP filing for the domain name in Alibaba Cloud ICP Filing System. If you have applied for an ICP filing for the domain name in other systems, you must add Alibaba Cloud as a service provider to the ICP filing. To apply for an ICP filing, you must obtain a service identification number. Each Alibaba Cloud Elastic Compute Service (ECS) instance with a public IP address provides five service identification numbers. |
|
Invalid%s.LengthLimit |
The parameter %s length exceeds the limit. |
400 |
The error message returned because the value of the %s parameter exceeds the upper limit in length. |
Change the parameter value and try again. |
|
InvalidApiDefault |
The ApiDefault value exceeds limit. |
400 |
The error message returned because the value of the apiDefault parameter exceeds the threshold. |
Change the value of the apiDefault parameter. The value of the apiDefault parameter cannot exceed 100 million, regardless of the unit. |
|
InvalidAppDefault |
The AppDefault value must smaller than the UserDefault and ApiDefault. |
400 |
The error message returned because the value of the appDefault parameter does not meet requirements. |
Change the value of the appDefault parameter. The value must be less than the value of the apiDefault parameter and the userDefault parameter. |
|
InvalidUserDefault |
The UserDefault value must bigger than the AppDefault and smaller than the ApiDefault. |
400 |
The error message returned because the value of the userDefault parameter does not meet requirements. |
Change the value of the userDefault parameter. The value must be greater than the value of the appDefault parameter but less than the value of the apiDefault parameter. |
|
InvalidParamMapping |
Parameters must be fully mapped. |
400 |
The error message returned because the parameter mapping is invalid. |
Specify a backend parameter for each request parameter. When you create an API, map each request parameter to a backend parameter. |
|
InvalidOwnerAccount |
OwnerAccount is invalid. |
400 |
The error message returned because the account of the application owner is invalid. |
When you authorize an account, specify the Alibaba Cloud mail address of the account owner. If the account is invalid, we recommend that you check the specified information and try again. |
|
ServiceForbidden |
Your Gateway service is forbidden by risk control. |
400 |
The error message returned because the API Gateway service is denied by the risk control system. |
Do not send a large number of requests in a short time. Try again later. |
|
ServiceUnOpen |
Your Gateway service has not been opened. |
400 |
The error message returned because API Gateway is not activated. |
Activate API Gateway on the Alibaba Cloud International site. |
|
ServiceInDept |
Your API Gateway service is in dept. |
400 |
The error message returned because the API Gateway service has overdue payments. |
Top up your account or settle the overdue payments. |
|
EqualSignature |
The new signature is the same as the old. |
400 |
The error message returned because the new backend signature key is the same as the previous one. |
Modify the backend signature key. Make sure that the newly configured key-secret pair is different from the previous one. |
|
CertificateNotMatch |
The domain does not match the one in the certificate. |
400 |
The error message returned because the specified domain name does not match the domain name in the certificate. |
Make sure that the specified domain name matches the domain name in the certificate. |
|
CertificateKeyNotMatch |
The certificate private key does not match the public key. |
400 |
The error message returned because the public and private keys in the certificate do not match. |
Check the certificate and make sure that the public and private keys in the certificate match. |
|
PrivateKeyEncrypted |
The certificate private key is encrypted, please upload the unencrypted version. |
400 |
The error message returned because the private key of the certificate is encrypted. |
Specify a private key that is not encrypted. |
|
CertificateSecretKeyError |
The certificate private key is invalid. |
400 |
The error message returned because the private key of the certificate is invalid. |
Specify a valid private key. |
|
InvalidApiServiceAddress |
The specified service address is not valid. |
400 |
The error message returned because the specified IP address of the backend service is invalid. |
Modify the configurations of the backend service. |
Common client error codes
A 4XX HTTP status code indicates a client-side error that may occur when you call Alibaba Cloud API operations. Common causes include invalid request formats, unsupported request methods, missing required parameters, malformed parameter values, invalid signatures, and throttling. Review the error details to troubleshoot the issue.
|
Scenario |
Error code |
Error message |
HTTP status code |
Solution |
|
The specified API cannot be found. |
InvalidApi.NotFound |
Specified api is not found, please check your url and method. |
404 |
Check whether the specified API operation name is valid. The name is case-sensitive. |
|
A required parameter is not specified. |
Missing{ParameterName} |
{ParameterName} is mandatory for this action. |
400 |
Specify the required parameter. |
|
The AccessKey ID cannot be found. |
InvalidAccessKeyId.NotFound |
Specified access key is not found. |
404 |
Check whether a valid AccessKey ID is used when you call the API. |
|
The AccessKey ID is disabled. |
InvalidAccessKeyId.Inactive |
Specified access key is disabled. |
400 |
Check whether the AccessKey pair is available. |
|
The format of the date or timestamp is invalid. |
InvalidTimeStamp.Format |
Specified time stamp or date value is not well formatted. |
400 |
Check the timestamp. |
|
The difference between the client time and server time exceeds 15 minutes. |
InvalidTimeStamp.Expired |
Specified time stamp or date value is expired. |
400 |
Check the timestamp. |
|
The SignatureNonce value has been used. |
SignatureNonceUsed |
Specified signature nonce was used already. |
400 |
|
|
The returned parameter value is in an invalid format. |
InvalidParameter.Format |
Specified parameter format is not valid. |
400 |
Specify the parameter only in the XML or JSON format. |
|
The parameter value verification failed. |
Invalid{ParameterName} |
Specified parameter {ParameterName} is not valid. |
400 |
Check the parameter value. |
|
The HTTP request method is not supported. |
UnsupportedHTTPMethod |
Specified signature is not matched with our calculation. |
400 |
Check the request method. |
|
The signature method is not supported. |
InvalidSignatureMethod |
Specified signature method is not valid. |
400 |
Specify an available signature method. This parameter can be left empty. |
|
The signature verification failed. |
SignatureDoesNotMatch |
Specified signature is not matched with our calculation. |
400 |
Check the signature. |
|
The user-level call frequency exceeds the threshold. |
Throttling.User |
Request was denied due to user flow control. |
400 |
Reduce the call frequency. |
|
The API-level call frequency exceeds the threshold. |
Throttling.API |
Request was denied due to api flow control. |
400 |
Reduce the call frequency. |
|
The AccessKey ID is missing. |
MissingSecurityToken |
SecurityToken is mandatory for this action. |
400 |
Check whether you specified a valid AccessKey ID. |