错误码 | 大装置帮助中心
跳到主要内容

错误码

在调用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表示业务错误码。

通用错误码

codemessageHTTP 状态码描述
1Canceled499客户端取消调用
2Unknown500未知错误
3InvalidArgument400请求参数不正确
4DeadlineExceeded504服务器内部超时
5NotFound404请求资源无效
6AlreadyExists409创建资源已存在
7PermissionDenied403账户没有对应操作权限
8ResourceExhausted429超出请求限制
9FailedPrecondition400操作条件未满足
10Aborted409并发冲突
11OutOfRange400超出范围
12Unimplemented501请求的方法/功能未实现
13Internal500服务器内部错误
14Unavailable503服务不可用
15DataLoss500数据丢失或损坏
16Unauthenticated401认证失败