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

公共返回参数

所有请求均返回JSON格式数据。下表描述了返回参数中的公共字段。

名称类型是否必须描述
code整型错误码,和HTTP状态码一致(但有扩展)。
  • 2xx:表示成功。
  • 4xx:表示请求有误。
  • 5xx:表示后端有误。

更多内容,请参见公共错误码

msg字符串错误的详细描述。
requestId字符串唯一标识该请求的ID,可用于定位问题。
data整型/字符串/JSON对象API(业务)相关的返回数据。出错情况下,该字段可能为空。一般来说,该字段为一个JSON结构体或数组。

公共错误码

错误代码HTTP 状态码描述
OK200请求成功。
PROCESSING280任务正在执行中,建议您等待一段时间(例如5s)后再查询结果。
BAD_REQUEST400请求有误,通常由于请求参数不正确导致,请仔细检查请求参数。
NOT_ALLOWED401请求失败,通常是由于使用了不安全的图片、视频、语音链接地址。
FORBIDDEN403请求访问失败,通常由于您的图片、视频、语音链接无法访问导致,请确认公网是否可访问,并且无防盗链策略。

如果访问地址为阿里云OSS文件路径,需要先授权内容安全访问OSS存储空间。

NOT_FOUND404待检测内容未找到,通常是由于您的图片、视频、语音内容无法下载导致,请确认内容可通过公网访问到。
DOWNLOAD_FAILED480下载失败,请确认待检测内容的大小、分辨率(如果有)在API的限制范围内。
GENERAL_ERROR500一般是服务端临时出错。建议重试,若持续返回该错误码,请通过在线服务联系我们。
ServiceUnavailable503一般为系统异常。建议您检查请求域名是否正常,如确认域名正常请通过在线服务联系我们并提供对应案例。
DB_FAILED580数据库操作失败。建议重试,若持续返回该错误码,请通过在线服务联系我们。
TIMEOUT581超时。建议重试,若持续返回该错误码,请通过在线服务联系我们。
CACHE_FAILED585缓存出错。建议重试,若持续返回该错误码,请通过在线服务联系我们。
ALGO_FAILED586算法出错。请通过在线服务联系我们。
MQ_FAILED587中间件出错。请通过在线服务联系我们。
EXCEED_QUOTA588请求频率超出配额。默认配额:图片检测50张/秒,视频检测20路/秒,语音检测20路/秒,文本检测100条/秒,图片OCR10张/秒。如果需要调整配额,请通过在线服务联系我们。
说明 关于价格说明,请参见内容安全产品定价
TOO_LARGE589待检测内容过大,请确保检测的内容在API的限制范围内。建议重试,若持续返回该错误码,请通过在线服务联系我们。
BAD_FORMAT590待检测内容格式错误,请确保检测的内容在API的限制范围内。
CONNECTION_POOL_FULL591连接池满。请通过在线服务联系我们。
DOWNLOAD_TIMEOUT592下载超时,下载时间限制为3s,请确保检测的内容大小在API的限制范围内。
EXPIRED594任务过期,如TaskId过期。
CATCH_FRAME_FAILED595截帧失败,请通过在线服务联系我们。
PERMISSION_DENY 596账号未授权、账号欠费、账号未开通、账号被禁等原因,具体可以参考返回的msg。