OkayAPI Docs


API Path: /api/App/Table/Query

API Description: 「即将弃用,请改用App.Table.FreeQuery」根据查询字段、查询条件、排序规则、分页查询数据。是最为灵活的查询,但只能单表查询,并符合安全规范。为保障数据安全,部分关键字会被转义,如select会被自动改为se1ect。

2
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
model_nameStringRequiredYour table Model Name
selectStringOptaion*SQL语句的SELECT部分,如:select=id,uuid
whereStringOptaionSQL语句的WHERE部分,如:where=id > 1
orderStringOptaionid DESCSQL语句的ORDER部分,如:order=id DESC
pageIntOptaion1MIN: 1第几页
perpageIntOptaion10MIN: 1;MAX: 10000分页数量
return_sqlBooleanOptaionfalse是否需要返回当前查询的sql片段,默认不返回,调试时可开启

API Debug

KEYREQUIREDVALUE
app_key *Required
model_name *Required
select Option
where Option
order Option
page Option
perpage Option
return_sql Option

API Response

KEYTypeDescription
err_codeInt状态操作码,0成功;1开发类错误,查询失败(表单不存在或查询错误);2应用层规则拦截,拦截后可以小白开放平台查看日记
err_msgString错误提示信息,err_code非0时参考此提示信息
totalInt数据的总条目数量
listArray查询的结果列表数据
sqlObject经过解析后的SQL语句片段,便于开发人进行校对(return_sql为true时才返回)
sql.selectString解析后的查询字段
sql.whereString解析后的查询条件
sql.orderString解析后的排序规则

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error