Error Return
Last Updated：2020-07-20
Error Return Format
SCS for Redis error response complies with the BCE specification and is unified in the following format. The subsequent interfaces are not listed separately.
| 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" : "AccessDenied",
"message" : "Access denied."
}The codes are an error ones, and all error code values are derived from BCE public error codes and SCS proprietary error codes.
BEC Public Error Code
| Error Return Code | Error Message | States Code | Description |
|---|---|---|---|
| AccessDenied | Access denied. | 403Forbidden | You’ve no permission to access 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 meanings does not meet the requirements. For example, a required item is missed, or the value type is not matched. For compatibility purpose, all unrecognized items is directly ignored and this error is not returned. |
| InternalError | We encountered an internal error Please try again. | 500 Internal Server Error | All other undefined errors. It shall not be used when there are other types of errors (including common and service customized errors) corresponded definitely. |
| InvalidAccessKeyId | The Access Key ID you provided doesnot exist in our records. | 403Forbidden | The Access Key ID does not exist. |
| InvalidHTTPAuthHeader | The Access Key ID you provided does not exist in our records. | 400 Bad Request | The Authorization header field format is error. |
| InvalidHTTPRequest | There was an error in the body of your HTTP request. | 400 Bad Request | The HTTP body format is error. For example, it does not conform to the specified Encoding etc. |
| InvalidURI | Could not parse the specified URI. | 400 Bad Request | URI form is incorrect. For example, the keywords defined by some services are not matched. For the problem of ID mismatching, more specific error codes shall be defined, such as NoSuchKey. |
| MalformedJSON | The JSON you provided was not well-formed. | 400 BadRequest | The JSON format is illegal. |
| InvalidVersion | The API version specified was invalid. | 404 NotFound | URI version number is illegal. |
| OptInRequired | A subscription for the service is required. | 403Forbidden | No corresponding service has been opened. |
| PreconditionFailed | The specified If-Match header doesn’tmatch the ETag header. | 412PreconditionFailed | For more information, please see Etag. |
| RequestExpired | Request has expired. Timestamp date is <Data>. | 400 Bad Request | Request timeout. Must change to x-bce-date. If there is only Date in the request, you need to change Date to date time. |
| IdempotentParameterMismatch | The request uses the same client token asa previous, but non-identical request. | 403Forbidden | API parameters corresponding to clientToken are different. |
| 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 to the Authorization header field is inconsistent with the server verification. |
Error Code
Please see all interface error codes.