错误码
在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。
概述
当API请求发生错误的时候,服务端会返回错误信息,包括HTTP的Status Code和响应Body中的具体错误细节。其中响应Body中的错误细节为如下格式:
{
"code": 3,
"message": "InvalidArgument",
"details": [
{
"@type": "type.googleapis.com/google.rpc.LocalizedMessage",
"locale": "zh-CN",
"message": "无效参数"
},
{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "INVALID_ARGUMENT",
"domain": "iam",
"metadata": {}
},
{
"@type": "type.googleapis.com/sensetime.core.higgs.error_detail.v1.LogInfo",
"log_id": "04ab61e6-fcc9-4da0-b860-298cd1a72a28",
"track_id": "",
"level": "UNSPECIFIED"
}
]
}
其中,code表示通用错误码,message表示code对应的描述信息,details表示错误细节。details中的reason表示业务错误码。
通用错误码
code | message | HTTP 状态码 | 描述 |
---|---|---|---|
1 | Canceled | 499 | 客户端取消调用 |
2 | Unknown | 500 | 未知错误 |
3 | InvalidArgument | 400 | 请求参数不正确 |
4 | DeadlineExceeded | 504 | 服务器内部超时 |
5 | NotFound | 404 | 请求资源无效 |
6 | AlreadyExists | 409 | 创建资源已存在 |
7 | PermissionDenied | 403 | 账户没有对应操作权限 |
8 | ResourceExhausted | 429 | 超出请求限制 |
9 | FailedPrecondition | 400 | 操作条件未满足 |
10 | Aborted | 409 | 并发冲突 |
11 | OutOfRange | 400 | 超出范围 |
12 | Unimplemented | 501 | 请求的方法/功能未实现 |
13 | Internal | 500 | 服务器内部错误 |
14 | Unavailable | 503 | 服务不可用 |
15 | DataLoss | 500 | 数据丢失或损坏 |
16 | Unauthenticated | 401 | 认证失败 |