OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
db_mark | String | Required | 数据库代号,待修改的数据库代号,必须先添加才能修改。 | ||
db_name | String | Optaion | 数据库名称,不传不修改 | ||
db_user | String | Optaion | 数据库账号,不传不修改 | ||
db_password | String | Optaion | 数据库密码,,不传不修改 | ||
db_host | String | Optaion | 数据库域名或者IP地址,不传不修改 | ||
db_port | Int | Optaion | 数据库端口,不传不修改,请确保此端口允许对外访问,或允许小白接口的IP白名单(联系小白技术客服索取) | ||
db_charset | Enum | Optaion | UTF-8 | Range: UTF-8/936/GBK | 数据库编码,不传不修改,注意大小写。当前支持的编码有:
|
db_enable | Boolean | Optaion | 数据库开关,不传不修改,1开0关 | ||
table_prefix | String | Optaion | MAX: 20 | 统一表前缀,不传不修改 | |
table_primary_key | String | Optaion | id | MAX: 20 | 统一表主键名,要求每个表格都需要有主键自增的id字段,不传不修改 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
db_mark | *Required | |
db_name | Option | |
db_user | Option | |
db_password | Option | |
db_host | Option | |
db_port | Option | |
db_charset | Option | |
db_enable | Option | |
table_prefix | Option | |
table_primary_key | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0成功,1数据库配置不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
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 |