本文介绍了调用内容检测API的公共返回参数和公共错误码。

公共返回参数

所有请求均返回JSON格式数据,有如下公共字段:
名称 类型 是否必需 描述
code 整形 错误码,和HTTP状态码一致(但有扩展)。
  • 2xx 表示成功。
  • 4xx 表示请求有误。
  • 5xx 表示后端有误。
具体参照公共错误码
msg 字符串 错误的进一步描述。
requestId 字符串 唯一标识该请求的ID,可用于定位问题。
data 整型/字符串/JSON对象 API(业务)相关的返回数据。出错情况下,该字段可能为空。一般来说,该字段为一个JSON结构体或数组。

公共错误码

错误代码 HTTP 状态码 描述
OK 200 请求成功。
PROCESSING 280 任务正在执行中,建议您等待一段时间后再查询结果(比如5s)。
BAD_REQUEST 400 请求有误。
NOT_ALLOWED 401 不允许,如使用了不安全的图片链接。
NOT_FOUND 404 未找到图片检测结果。
DOWNLOAD_FAILED 480 下载失败。
GENERAL_ERROR 500 一般是服务端临时出错。
DB_FAILED 580 数据库操作失败。
TIMEOUT 581 超时。
CACHE_FAILED 585 缓存出错。
ALGO_FAILED 586 算法出错。
MQ_FAILED 587 中间件出错。
EXCEED_QUOTA 588 超出配额。
TOO_LARGE 589 图片过大。
BAD_FORMAT 590 格式错误。
CONNECTION_POOL_FULL 591 连接池满。
DOWNLOAD_TIMEOUT 592 下载超时,下载时间限制为3s。
EXPIRED 594 任务过期,如taskId过期。
CATCH_FRAME_FAILED 595 截帧失败。
PERMISSION_DENY 596 账号未授权,账号欠费,账号未开通,账号被禁,具体可以参考返回的msg。