错误定义
UC API使用HTTP状态码来反映请求操作成功或失败。2XX状态码表示操作成功,4XX或5XX状态码表示操作错误。如果收到错误的状态码,可以根据响应报文体中错误码和错误信息了解错误原因。
| 状态码 | 描述 | 场景举例 |
|---|---|---|
| 2XX | 操作成功 | |
| 400 | 请求数据错误 | 无效的或不完整的请求数据 |
| 401 | 身份认证错误 | 请求没有携带访问 token |
| 403 | 不允许访问某些资源 | 鉴权不通过 |
| 404 | 没有找到和请求相匹配的数据 | 没有找到数据 |
| 429 | 请求次数超过频率限制 | 请求太频繁 |
| 500 | 服务器错误 | 服务器内部异常 |
错误对象定义
错误(Error)对象
| 名称 | 数据类型 | 描述 |
|---|---|---|
| code | String | 服务端定义的错误码,用于快速定位问题 |
| requestId | String | 服务端生成的请求ID,用于在服务端跟踪请求执行情况。能够帮助开发人员快速定位问题 |
| message | String | 简单明了的错误描述,能够被终端用户所理解 |
| details | ErrorDetail[] | 导致错误的详细信息列表,可能为空 |
错误明细(ErrorDetail)对象
| 名称 | 数据类型 | 描述 |
|---|---|---|
| field | String | 出现错误的请求参数名称 |
| message | String | 简单明了的错误描述,能够被终端用户所理解 |
错误响应示例
{
"code": "{errorCode}",
"requestId": "{requestId}",
"message": "Validation Failed",
"details": [
{
"field": "email",
"message": "Invalid field"
},
{
"field": "type",
"message": "Invalid field"
}
]
}