公共头和错误返回
更新时间:2019-06-14
公共头规格
公共请求头
公共头部 | 描述 |
---|---|
Authorization | 包含Access Key与请求签名。 |
Content-Type | application/json; charset=utf-8。 |
x-bce-date | 表示日期的字符串,符合API规范。 |
HTTP协议的标准头域不再这里列出。公共头域将在每个BCC API中出现,是必需的头域。POST、PUT、DELETE等请求数据放在request body中。
公共响应头
公共头部 | 描述 |
---|---|
Content-Type | application/json; charset=utf-8。 |
x-bce-request-id | BSG后端生成,并自动设置到响应头域中。 |
错误返回
当用户访问BSG出现错误时,BSG会返回给用户相应的错误码和错误信息,便于用户定位问题,并做出适当的处理。请求发生错误时通过Response Body返回详细错误信息,遵循如下格式:
参数名 | 类型 | 说明 |
---|---|---|
code | String | 错误码 |
message | String | 错误描述 |
requestId | String | 本次请求的requestId |
示例:
{
"code": "NoSuchObject",
"message": "account not exist",
"requestId": "c4abab14-ebc4-4eb0-85d2-03c4d51eed18"
}
BCE公共错误码
错误返回码 | 错误消息 | 状态码 | 说明 |
---|---|---|---|
AccessDenied | Access denied. | 403Forbidden | 无权限访问对应的资源。 |
InappropriateJSON | The JSON you provided was well-formed and valid, but not appropriate forthis operation. | 400 Bad Request | 请求中的JSON格式正确,但语义上不符合要求。如缺少某个必需项,或值类型不匹配等。出于兼容性考虑,对于所有无法识别的项应直接忽略,不应该返回这个错误。 |
InternalError | We encountered an internal error Please try again. | 500 Internal Server Error | 所有未定义的其他错误。在有明确对应的其他类型的错误时(包括通用的和服务自定义的)不应该使用。 |
InvalidAccessKeyId | The Access Key ID you provided doesnot exist in our records. | 403Forbidden | Access Key ID不存在。 |
InvalidHTTPAuthHeader | The Access Key ID you provided does notexist in our records. | 400 BadRequest | Authorization头域格式错误。 |
InvalidHTTPRequest | There was an error in the body of your HTTP request. | 400 Bad Request | HTTP body格式错误。例如不符合指定的Encoding等。 |
InvalidURI | Could not parse the specified URI. | 400 Bad Request | URI形式不正确。例如一些服务定义的关键词不匹配等。对于ID不匹配的问题,应定义更加具体的错误码,如NoSuchKey。 |
MalformedJSON | The JSON you provided was not well-formed. | 400 BadRequest | JSON格式不合法。 |
InvalidVersion | The API version specified was invalid. | 404 NotFound | URI的版本号不合法。 |
OptInRequired | A subscription for the service is required. | 403Forbidden | 没有开通对应的服务。 |
PreconditionFailed | The specified If-Match header doesn’tmatch the ETag header. | 412PreconditionFailed | 详见Etag。 |
RequestExpired | Request has expired. Timestamp date is <Data>. | 400 BadRequest | 请求超时。要改成x-bce-date。若请求中只有Date,需将Date转成datetime。 |
IdempotentParameterMismatch | The request uses the same client token asa previous, but non-identical request. | 403Forbidden | clientToken对应的API参数不一样。 |
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 | Authorization头域中附带的签名和服务端验证不一致。 |
BSG错误返回码
错误码 | 错误描述 | HTTP状态码 | 中文解释 |
---|---|---|---|
BadRequest | Bad request parameters or illegal request. | 400 | 请求有误 |
EipNotFound | The specified object is not found or resource do not exist. | 404 | 资源不存在 |
AccountNotFound | Account not exist. | 404 | 账户不存在 |
GroupNotFound Group | not exist. | 404 | 权限组不存在 |
TargetNotFound | Target not exist. | 404 | 共享目标不存在 |
GatewayNotFound | Gateway not exist. | 404 | 存储网关不存在 |
OperationDenied | The target resource has been used. | 403 | 拒绝操作(重复名字) |
OperationForbidden | Operation forbidden. | 409 | 禁止操作(状态不允许操作) |
DupliatedName | Account name exists. | 403 | 拒绝操作(重复名字) |
QuotaExceededLimit | Quota exceededs limit. | 409 | quota超限 |
DecryptFailed Decrypt | the password failed. | 400 | 解密密码失败 |