公共参数
2023.04.26 16:47:57
公共请求参数
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| secretId | String | Y | 32 | 产品秘钥 id ，由易盾内容安全服务分配，产品标识 |
| businessId | String | Y | 32 | 推荐使用businessId(业务id)鉴权，使用无限制且灵活；scene 为场景标识，用于多业务在同一场景下调用时使用，同一产品下同一业务类型仅能指向一个场景，此处参数由易盾内容安全服务分配 |
| timestamp | Number | Y | 13 | 请求当前 UNIX 时间戳，请注意服务器时间是否同步 |
| nonce | String | Y | 32 | 随机数字，与 timestamp 联合起来，用于防止重放攻击 |
| signatureMethod | String | N | 指定传参 | 指定签名算法，国密：SM3,如果使用md5默认签名算法，可以不传 |
| signature | String | Y | 32 | 请求签名，用来验证此次请求的合法性，具体算法见接口鉴权 |
响应公共字段
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Number | 接口调用状态，200:正常，其他值：调用出错，返回码见响应返回码 |
| msg | String | 结果说明，如果接口调用出错，那么返回错误描述，成功返回 ok |
| data | 数组或对象 | 接口返回结果，各个接口自定义，若为空标识返回正常，返回数据结构请参考具体文档说明 |
响应返回码
| 返回码 | 返回码描述 | 说明 |
|---|---|---|
| 200 | ok | 接口调用成功 |
| 400 | 参数错误 | 详细错误见msg |
| 405 | QPS超限 | 请求频率超过限制 |
| 406 | 套餐余量不足 | 套餐余量不足，请购买新套餐 |
| 500 | 服务异常 | 接口异常 |
