OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
select | ArraySeperated with , | Optaion | 需要返回的字段,多个字段用英文逗号分割,如:select=id,file_url,默认返回全部。 | ||
file_name | String | Optaion | 需要查询的文件名,支持模糊匹配和搜索。 | ||
file_type | ArraySeperated with , | Optaion | 需要搜索的文件分类,支持同时查询多个,多个分类使用英文逗号分割。为空时查全部。例如:file_type=aa,bb,cc | ||
order_type | Int | Optaion | 1 | 排序类型,默认order_type=1,表示按默认的顺序,即上传时间降序;order_type=2表示上传时间升序;order_type=3,按文件名降序,order_type=4,按文件名升序;order_type=5,按文件大小降序,order_type=6,按文件大小升序。 | |
page | Int | Optaion | 1 | 第几页 | |
perpage | Int | Optaion | 20 | MAX: 10000 | 分页数量 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
select | Option | |
file_name | Option | |
file_type | Option | |
order_type | Option | |
page | Option | |
perpage | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
total | Int | 上传文件的总数量 |
list | Array | 查询或搜索的上传文件列表 |
list[].id | Int | ID |
list[].file_name | String | 文件图片名称 |
list[].file_type | String | 文件分类,或文件类型 |
list[].file_size | Int | 文件大小,单位:Byte |
list[].add_time | String | 文件上传时间 |
list[].file_url | String | 文件图片完整链接 |
list[].https_url | String | 成功上传时返回的HTTPS URL,失败或不支持HTTPS时为空 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |