OkayAPI Docs


API Path: /api/App/SuperTable/SqlQuery

API Description: 可以通过原始SQL语句,查询数据库,并返回全部结果集。你可以通过配置小白直连数据库账号的权限来控制允许查询哪些表。注意查询的结果不要过大,以免卡死!

1
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_nameStringRequired此时的表名可任意指定一个
databaseStringOptaionsuper自己的数据库配置标记,注意!这是数据库的配置标识,不是数据库的名称。默认使用super,不用传。如果需要配置多个数据库时,可与小白技术人员联系。重要事情说三遍,这是数据配置标识,不是数据库名称。使用此接口前,请先进入:数据库直连服务配置
sqlStringRequired待查询的完整SQL语句,须符合MySQL数据库语法,只支持SELECT系列的操作。推荐此参数使用POST方式,若使用GET方式须进行URL编码,以免解析出错

API Debug

KEYREQUIREDVALUE
app_key *Required
model_name *Required
database Option
sql *Required

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息
sqlArray返回本次成功查询的结果

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