公共参数
全局请求参数
| 名称 | 类型 | 说明 |
|---|---|---|
| ApiKey | header | ApiKey；查看ApiKey |
全局响应参数
| 名称 | 类型 | 说明 |
|---|---|---|
| code | number(int) | http status |
| data | object | 响应数据（参考各接口文档） |
| reason | string | 错误码（错误唯一标识） |
| message | string | 错误信息 |
| metadata | string | 请求信息 |
| - request_id | string | 请求ID |
全局错误码
- 错误码是作为错误判断的全局唯一标识；不能通过 http status code 进行错误判断。
| http status | 错误码 | 错误说明 |
|---|---|---|
| 400 | UNEXPECT_ERR | 未知错误；请联系客服。 |
| 400 | CODEC | 请求失败。请检查请求格式是否规范 |
| 400 | VALIDATOR | 请求参数检验失败。请检查请求参数是否符合要求 |
| 401 | API_KEY_ERROR | ApiKey错误；查看ApiKey |
| 403 | BALANCE_NOT_ENOUGH | 余额不足；查询余额 |
| 403 | API_KEY_NOT_ACTIVE | ApiKey不可用；请联系客服。 |
| 403 | IP_NOT_ALLOWED | IP不允许；查看ip白名单配置 |
| 500 | INTERNAL_SERVER_ERR | 内部错误；请联系客服。 |