服务有统一的返回结构及通用错误码。
服务会返回一个JSON结构体,具体字段说明如下:
字段 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
ResponseMetadata | json | 否 | 网关层返回值,若此字段返回且值不为None,则无需关注其他字段 |
request_id | String | 否,若ResponseMetadata未返回或值为None时,必返回 | 服务层返回值,代表此次请求的唯一ID |
time_elapsed | Int | 否,若ResponseMetadata未返回或值为None时,必返回 | 服务层返回值,整个请求所花费的时间,单位为毫秒 |
code | Int | 否,若ResponseMetadata未返回或值为None时,必返回 | 服务层返回值,表示本次验证的结果状态码。 详见下方 服务通用错误码 和各服务接口文档中错误码 部分 |
message | String | 否,若ResponseMetadata未返回或值为None时,必返回 | 服务层返回值,当请求失败时返回此字符串,否则此字段不存在 |
data | json | 否,若ResponseMetadata未返回或值为None时,必返回 | 服务层返回值,json结构,里面包含的是各接口的业务数据,详细说明见各服务接口文档 |
字段 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
RequestId | string | 是 | 网关层请求的唯一ID |
Action | string | 否 | 接口名 |
Version | string | 否 | 版本号 |
Service | string | 否 | 服务名 |
Region | string | 否 | 地区 |
Error | ErrorInfo | 否 | 错误信息 |
字段 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
Code | string | 是 | 网关层错误码,详见网关公共错误码 |
Message | string | 是 | 网关层错误信息,详见网关公共错误码 |
http_code | code | 状态类型 | 说明 | 建议处理方式 |
---|---|---|---|---|
200 | 10000 | ECSuccess | 请求成功 | |
400 | 50200 | ECReqInvalidArgs | 参数错误 | 检查入参及MIME类型 |
400 | 50201 | ECReqMissingArgs | 缺少参数 | 检查入参及MIME类型 |
400 | 50204 | ECParseArgs | 参数类型错误/参数缺失 | 检查入参及MIME类型 |
400 | 50205 | ECImageSizeLimited | 图像尺寸超过限制 | 参考接口文档入参要求部分 |
400 | 50206 | ECImageEmpty | 请求参数中没有获取到图像 | 检查入参 |
400 | 50207 | ECImageDecodeError | 图像解码错误: 没有获取到图像或者通过image_base64参数传递图像是base64解码错误 | 检查输出图片或检查base64是否错误携带前缀 |
400 | 50209 | ECVideoEmpty | 请求参数中没有获取到视频。输入为视频时可能返回此错误 | 检查入参 |
400 | 50210 | ECVideoDecodeError | 视频解码错误。输入为视频时可能返回此错误。 | 检查输入视频是否不正确 |
400 | 50211 | ECVideoSizeLimited | 视频尺寸超过限制。输入为视频时可能返回此错误。 | 检查输入视频大小 |
400 | 50213 | ECReqBodySizeLimited | 请求Body过大, 超出接口限制。 | 检查请求Body大小 |
400 | 50214 | ECVideoTimeTooLong | 输入视频时长过大 | 检查输入视频时长 |
400 | 50215 | ECRPCProcess | 由于输入的图片、视频、参数等不满足要求,导致请求处理失败。若接口文档中有具体说明,优先参考其具体含义。 | 按照具体服务说明进行检查 |
400 | 60102 | ECJPFaceDetect | 算法服务需要输入人脸图,但未检测到 | 检查输入图片是否包含人脸 |
400 | 60208 | ECFSLeaderRiskError | 输入图片中包含敏感信息,未通过审核 | |
401 | 50400 | ECAuth | 权限校验失败 | 请检查是否已创建应用并开通服务或签名,参考接入指南 及快速接入 |
404 | 50402 | ECReqMethod | 访问的接口不存在 | 检查入参 |
404 | 50429 | ECReqLimit | 超过调用QPS限制 | 购买QPS增项包 |
500 | 50500 | ECInternal | 服务器内部错误 | 提工单 |
500 | 50501 | ECRPCInternal | 服务器内部RPC错误 | 提工单 |