API返回信息
返回结构
API返回的信息中,
status
代表了本次请求是否成功,其余结果信息放置于res
字段内,request_id
则包含了本次请求的ID标准的返回格式为
{ "status": true/false, // 是否成功调用接口 "res": { // 调用结果 ... }, "request_id": "tr_xxxxxxxxxx" // 请求ID }
错误代码
errType名称 | HTTP状态码 | 说明 |
---|---|---|
api_not_find | 404 | 找不到对应的API或对应的版本 |
req_method_error | 405 | 错误的请求方法(如GET,POST) |
req_unauthorized | 401 | 鉴权失败(任何细节的错误都将导致返回这一结果,请仔细检查!) |
resource_no_valid | 402 | 没有可以用以调用接口的资源,如无资源包或账户余额不足 |
image_missing | 413 | 没有上传图片文件 |
image_oversize | 413 | 图片文件过大 |
sever_closed | 503 | 服务器未启动/维护中 |
server_error | 500 | 服务器内部错误 |
exceed_max_qps | 429 | 超出最大调用的QPS,请稍后再试 |
exceed_max_ccy | 429 | 超出最大调用的并发请求量,请稍后再试 |
server_inference_error | 500 | 服务器推理错误 |
image_proc_error | 500 | 上传图片处理错误 |
invalid_param | 500 | 不合法的参数导致的服务器错误 |
too_many_file | 500 | 文件太多导致的服务器错误 |
no_file_error | 500 | 没有文件导致的服务器错误 |