Error Return
Last Updated:2020-07-20
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 | Error code |
message | String | Err description |
requestId | String | RequestID of this request |
Example:
{
"requestId" : "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code" : "NoSuchKey",
"message" : "The resource you requested does not exist"
}
The error codes are divided into public error codes of Baidu AI Cloud and peculiar error codes of WAF services. The specific error codes are as follows:
BCE Common Error Code
Error return code | Error message | status code | Description |
---|---|---|---|
AccessDenied | Access denied. | 403Forbidden | No permission to access the corresponding resource. |
InappropriateJSON | The JSON you provided was well-formed and valid, but not appropriate forthis operation. | 400 Bad Request | The JSON format in the request is correct, but doesn't meet the requirements semantically, For example, a required item is missing, or the value type does not match. 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. | 500 Internal 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 doesnot exist in our records. | 403Forbidden | Access key ID does not exist. |
InvalidHTTPAuthHeader | The Access Key ID you provided does notexist in our records. | 400 BadRequest | 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, more specific error codes should be defined, such as NoSuchKey. |
MalformedJSON | The JSON you provided was not well-formed. | 400 BadRequest | Illegal JSON format. |
InvalidVersion | The API version specified was invalid. | 404 NotFound | The version number of the URI is illegal. |
OptInRequired | A subscription for the service is required. | 403Forbidden | No corresponding service has been enabled. |
PreconditionFailed | The specified If-Match header doesn ' tmatch the ETag header. | 412PreconditionFailed | See Etag for details. |
RequestExpired | Request has expired. Timestamp date is <Data>. | 400 BadRequest | The request has timed out. Change to x-bce-date. If only Date exists in the request, you need to convert Date to datetime. |
IdempotentParameterMismatch | The request uses the same client token asa previous, but non-identical request. | 403Forbidden | The API parameters corresponding to clientToken are non-identical. |
SignatureDoesNotMatch | The request signature we calculated does not match the signature you provided. Check yourSecret Access Key and signing method. Consultthe service documentation for details. | 400 Bad Request | The signature attached in the authorization header field is inconsistent with the server-side verification. |
Waf Business Error Code
Error code | Err description | HTTP status code | Semantics |
---|---|---|---|
ReadWafDenied | No read waf permission | 403 | No waf read service permission |
OperateWafDenied | No operate waf permission | 403 | No waf operation permission |
WafAdminDenied | No waf admin permission | 403 | No waf administration permission |
UnsupportedWAFOperation | The status of specified waf does not support this operation | 400 | The status of waf instance doesn't support operation. |
WafInterfaceError | The interface not supporte this kind of waf type | 400 | The called interface doesn't support the passed waf instance type. |
WafBindNotFound | The specified waf bind does not exist | 404 | The blb identifier to be bound is not found. |
WafUnBindNotFound | The specified waf unbind does not exist | 404 | The blb to be unbound is not found. |
WafBindRepeatError | The specified waf bind is repetition | 400 | The blb is bound to waf and not unbound. |
InvalidParameter | Invalid Parameters | 400 | The parameter passed in by the interface is invalid. |