响应返回码
2024.09.26 20:30:17
概述
内容安全服务的接口响应结构是一致的,都包含了 code 和 msg 字段。
code 字段表示接口调用的返回码,直接反映接口的调用结果。当 code 不等于 200 时,表示接口调用异常。
msg 字段是对 code 的详细解释,包含了异常类型、异常原因以及解决方案等信息,通过该字段可以精确定位原因和获取解决方案。
返回码
code | 说明 | msg 示例 |
---|---|---|
200 | 接口调用成功 | 成功 |
400 | 缺少 secretId 或 businessId | 错误的请求,请求缺少参数 secretId,请设置有效值 |
401 | 产品/业务无效或过期 | 未经授权,请检查 secretId 是否正确,若产品试用到期请联系商务 |
405 | 参数错误,包括参数格式、类型等错误 | 参数错误,参数 timestamp 不能为空,请设置为当前时间戳 |
410 | 签名验证失败 | 签名验证失败,请参考 接口鉴权说明 |
411 | 请求频率超过限制,qps 默认限制试用期 10 个/小时,正式默认 30 /s | 请求频率超出限制,如需调整请联系商务 |
412 | 检测并发/缓冲池超限,默认限制为 30 路 | 检测并发超限,如需调整请联系商务 |
413 | 试用期请求数据总量超过限制,试用默认上限 100 路,自助接入默认上限 10 路 | 试用检测总量超限,如需调整请联系商务 |
414 | 请求长度/大小超过限制,包含字段长度、请求体大小超限 | 请求长度超过限制,参数 dataId 最大长度为 128,当前长度为 160 |
415 | 业务版本限制 | 业务版本限制,参数 version 与接口版本不匹配,正确的版本范围为 v4-v4.3 |
417 | 重复提交,msg 返回重复的检测任务 id | 38e08da8d2574df4bd2eca9b5153df72 |
503 | 接口异常 | 服务发生异常,请稍后重试 |
示例
{
"code": 400,
"msg": "错误的请求,请求缺少参数businessId,请设置有效值"
}
示例说明:通过 code 为 400 初步判断是缺少 secretId 或 businessId 参数导致的, 从 msg 进一步得知是缺少 businessId 参数导致的。