Error Return
Last Updated：2020-09-29
When an error occurs for a request, the detailed error information is returned via the response body in the following format:
| Parameter Name | Type | Description |
| code | String | Error code |
| message | String | Error description |
| requestId | String | requestId of this request |
Example:
{
"requestId" : "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code" : "NoSuchKey",
"message" : "The resource you requested does not exist"
}Common Error Code
| Error Return Code | Error Message | States Code | Description |
|---|---|---|---|
| AccessDenied | Access denied. | 403 Forbidden | You have no privilege to access the corresponding resources. |
| 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 its semantics does not comply with requirements. For example, a required item is missing, the value type is not matched, etc. For the compatibility purpose, all unrecognized items need to be directly ignored, and this error should not be returned. |
| InternalError | We encountered an internal error. Please try again. |
500 Internal Server Error |
All other undefined errors. When other types of corresponding errors (including common and service-customized errors) are available, this type of error needs to be avoided. |
| InvalidAccessKeyId | The Access Key ID you provided does not exist in our records. | 403 Forbidden | The Access Key ID is not available. |
| InvalidHTTPAuthHeader | The Access Key ID you provided does not exist in our records. | 400 Bad Request | The format of the Authorization header field is incorrect. |
| InvalidHTTPRequest | There was an error in the body of your HTTP request. |
400 Bad Request |
The format of the HTTP body is incorrect. For example, it does not comply with the requirements of encoding. |
| InvalidURI | Could not parse the specified URI. | 400 Bad Request |
The URI form is incorrect. For example, some keywords defined by services are not matched. For the mismatched ID, the specific error code needs to be defined, such as NoSuchKey. |
| MalformedJSON | The JSON you provided was not well-formed. | 400 Bad Request | The JSON format is invalid. |
| InvalidVersion | The API version specified was invalid. | 404 Not Found | The URI version number is invalid. |
| 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 | For more information, please see Etag. |
| RequestExpired | Request has expired. Timestamp date is <Data> . | 400 Bad Request | Your request has timed out. It needs to be changed into x-bce-date. If your request only contains Date, you need to change it into 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 different. |
| 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 to the Authorization header field is different from the one verified by the server. |