Error Return
Last Updated：2020-07-20
Error Code Format
When an error occurs when the user accesses API, the corresponding error code and error message will be returned to the user to facilitate localization and make appropriate processing. The detailed error information is returned through Response Body in case of a request error, and the following format is followed:
| Parameter name | Type | Description |
|---|---|---|
| code | String | It means a specific error type. |
| message | String | Detailed description on the error. |
| requestId | String | RequestId causing the error. |
E.g.:
{
"code":"InvalidHTTPRequest",
"message":"The specified parameter queryAccountId is invalid! ",
"requestId":" 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7"
}Public Error Code
| Error code | Error message | HTTP status code | Description |
|---|---|---|---|
| AccessDenied | Access denied. | 403 Forbidden | No permission to access the corresponding resource. |
| InappropriateJSON | The JSON you provided was well-formed and valid, but not appropriate for this operation. | 400 Bad Request | The JSON format in the request is correct, but doesn't meet the requirements semantically, such as lack of one necessary item or value type mismatch. For consideration of compatibility, all unrecognizable items should be ignored directly, and this error should not be returned. |
| InternalError | We encountered an internal error. Please try again. | 500Internal Server Error | All other undefined errors should not be utilized when there are specific corresponding other types of errors (including generic and service customized errors). |
| InvalidAccessKeyId | The Access Key ID you provided does not exist in our records. | 403 Forbidden | Access key ID does not exist. |
| InvalidHTTPAuthHeader | The HTTP authorization header is invalid. Consult the service documentation for details. | 400 Bad Request | Authorization header field format error. |
| InvalidHTTPRequest | There was an error in the body of your HTTP request. | 400 Bad Request | The HTTP body format is wrong. For example, it does not conform to the specified Encoding. |
| InvalidURI | Could not parse the specified URI. | 400 Bad Request | The URI format is incorrect, such as mismatch of some service-defined keywords. For ID mismatch and other problems, a more specific error code should be defined, such as NoSuchKey. |
| MalformedJSON | The JSON you provided was not well-formed. | 400 Bad Request | Illegal JSON format. |
| InvalidVersion | The API version specified was invalid. | 404 Not Found | The version number of the URI is illegal. |
| OptInRequired | A subscription for the service is required. | 403 Forbidden | No corresponding service has been enabled. |
| PreconditionFailed | The specified If-Match header doesn't match the ETag header. | 412 Precondition Failed | Refer to ETag for details. |
| RequestExpired | Request has expired. Timestamp date is XXX. | 400 Bad Request | The request has timed out. XXX should be changed to the value of x-bce-date. If there is only Date in the request, the Date should be changed to datetime. |
| IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. | 403 Forbidden | The API parameters corresponding to clientToken are non-identical. |
| SignatureDoesNotMatch | The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details. | 400 Bad Request | The signature attached in the authorization header field is inconsistent with the server-side verification. |
BILLING Error Return Code
The following table lists the error codes specific to the BILLING API.
| Error code | Error message | HTTP status code | Description |
|---|---|---|---|
| QualifyNotPass | The User has not pass qualify. | 403 | Account has not passed identity verification |
| InvalidHTTPRequest | The specified parameter xxx is invalid! | 400 | The request parameter is set incorrectly |
| BCE BILLING system busy | BCE BILLING system is busy! | 400 | Requests are too frequent, please do not over-request |
| AccessDenied | User: xxx Authentication failure! | 400 | Authentication failure |
| RateLimit | RateLimit | 421 | Exceed access speed limit |
| InvalidParameter | The parameter 'parameterName' is invalid. | 400 | "parameterName" parameter is invalid. |
| ServiceInternalError | Internal service occurs error. | 500 | Internal service error |