OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
model_name | String | Required | 数据库表名 | ||
database | String | Optaion | super | 自己的数据库配置标记,注意!这是数据库的配置标识,不是数据库的名称。默认使用super,不用传。如果需要配置多个数据库时,可与小白技术人员联系。重要事情说三遍,这是数据配置标识,不是数据库名称。使用此接口前,请先进入:数据库直连服务配置。 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
model_name | *Required | |
database | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功;1开发类错误 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
desc | Array | 表结构描述 |
desc[].Field | String | 字段名称 |
desc[].Type | String | 字段类型,例如:int(11) |
desc[].Collation | String | 字段编码,例如:utf8mb4_general_ci |
desc[].Null | String | 是否允许为空,YES/NO |
desc[].Key | String | 字段索引,空/PRI/NOR |
desc[].Default | String | 默认值 |
desc[].Extra | String | 额外信息,例如:auto_increment |
desc[].Comment | String | 字段注释 |
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 |