错误返回
更新时间:2021-08-02
当用户访问API出现错误时,会返回给用户相应的错误码和错误信息,便于定位问题,并做出适当的处理。用户的请求会先经过网关,通过网关后才会转发到平台进行处理。当请求发生错误时,可能是网关的错误,也可能是平台的错误。
如果是网关发生错误,会将错误的信息写到响应的头部,遵循如下格式:
参数名 | 类型 | 说明 |
---|---|---|
X-Bce-Request-Id | String | 表示响应对应请求的RequestId |
X-Bce-Error-Code | String | 表示异常情况下的错误码 |
X-Bce-Error-Message | String | 表示异常情况下的错误信息 |
示例:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
X-Bce-Exception-Point: Gateway
X-Bce-Request-Id: d8752367-38e8-45e4-b4c7-e53be3137ce5
X-Bce-Error-Code: ResourceNotFound
X-Bce-Error-Message: Resource not found.
请求发生平台错误时通过Response Body返回详细错误信息,遵循如下格式:
参数名 | 类型 | 说明 |
---|---|---|
code | String | 表示该错误的返回码 |
msg | String | 表示该错误的详细说明 |
data | json | 表示请求正常时的数据返回 |
示例:
{
"code": "9001",
"msg": "请求参数错误",
"data": null
}
BEC服务错误码
错误码 | HTTP状态码 | 描述 |
---|---|---|
AccessDenied | 403 | 无权限访问对应的资源 |
Resource Not Found | 404 | 所请求的资源不存在 |
BadRequest | 400 | 请求错误 |
Illegal parameters | 400 | 请求参数错误 |
AccountNotActivate | 400 | 账户未激活 |
AccountArrears | 400 | 账户欠费 |
Bec internal exception | 500 | 服务器内部错误 |
Bec.K8SClientError | 500 | kubernetes内部错误 |
Bec.NamespaceError | 500 | 命名空间校验错误 |
Failed to generate BEC resource | 500 | 资源创建错误 |