You need to enable JavaScript to run this app.
导航
通用返回字段及错误码
最近更新时间:2024.03.07 19:59:41首次发布时间:2021.06.28 17:34:02

整体说明

服务有统一的返回结构及通用错误码。

通用返回字段

服务会返回一个JSON结构体,具体字段说明如下:

字段类型是否必返回说明
ResponseMetadatajson网关层返回值,若此字段返回且值不为None,则无需关注其他字段
request_idString否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,代表此次请求的唯一ID
time_elapsedInt否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,整个请求所花费的时间,单位为毫秒
codeInt否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,表示本次验证的结果状态码。
详见下方服务通用错误码和各服务接口文档中错误码部分
messageString否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,当请求失败时返回此字符串,否则此字段不存在
datajson否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,json结构,里面包含的是各接口的业务数据,详细说明见各服务接口文档

ResponseMetadata字段说明

字段类型是否必返回说明
RequestIdstring网关层请求的唯一ID
Actionstring接口名
Versionstring版本号
Servicestring服务名
Regionstring地区
ErrorErrorInfo错误信息

ErrorInfo字段说明

字段类型是否必返回说明
Codestring网关层错误码,详见网关公共错误码
Messagestring网关层错误信息,详见网关公共错误码

服务通用错误码

http_codecode状态类型说明建议处理方式
20010000ECSuccess请求成功
40050200ECReqInvalidArgs参数错误检查入参及MIME类型
40050201ECReqMissingArgs缺少参数检查入参及MIME类型
40050204ECParseArgs参数类型错误/参数缺失检查入参及MIME类型
40050205ECImageSizeLimited图像尺寸超过限制参考接口文档入参要求部分
40050206ECImageEmpty请求参数中没有获取到图像检查入参
40050207ECImageDecodeError图像解码错误: 没有获取到图像或者通过image_base64参数传递图像是base64解码错误检查输出图片或检查base64是否错误携带前缀
40050209ECVideoEmpty请求参数中没有获取到视频。输入为视频时可能返回此错误检查入参
40050210ECVideoDecodeError视频解码错误。输入为视频时可能返回此错误。检查输入视频是否不正确
40050211ECVideoSizeLimited视频尺寸超过限制。输入为视频时可能返回此错误。检查输入视频大小
40050213ECReqBodySizeLimited请求Body过大, 超出接口限制。检查请求Body大小
40050214ECVideoTimeTooLong输入视频时长过大检查输入视频时长
40050215ECRPCProcess由于输入的图片、视频、参数等不满足要求,导致请求处理失败。若接口文档中有具体说明,优先参考其具体含义。按照具体服务说明进行检查
40060102ECJPFaceDetect算法服务需要输入人脸图,但未检测到检查输入图片是否包含人脸
40060208ECFSLeaderRiskError输入图片中包含敏感信息,未通过审核
40150400ECAuth权限校验失败请检查是否已创建应用并开通服务或签名,参考接入指南快速接入
40450402ECReqMethod访问的接口不存在检查入参
40450429ECReqLimit超过调用QPS限制购买QPS增项包
50050500ECInternal服务器内部错误提工单
50050501ECRPCInternal服务器内部RPC错误提工单