OkayAPI Docs


API Path: /api/App/DB_MsSQL_Config/AddNewDatabaseConfig

API Description: 添加新数据库连接配置,数据库必须是现有的数据库,或者需要开发者自己创建。

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
db_markStringRequired数据库代号,对外暴露简短的数据库代号,避免数据库名字泄露。需要唯一指定,不能重复。
db_nameStringRequired数据库名称。创建sql server数据库并设置编码,可使用:CREATE DATABASE TestDB; ALTER DATABASE TestDB collate chinese_prc_ci_as;
db_userStringRequired数据库账号,推荐单独创建新的数据库账号,可使用:USE TestDB; create user yesapi_dba for login yesapi_dba with default_schema=dbo; exec sp_addrolemember 'db_owner', 'yesapi_dba';
db_passwordStringRequired数据库密码,将采用RSA加密算法存储以确保密码的安全性。此外,推荐单独为小白接口创建独立的数据库账号,或者有需要可联系小白技术人员进行代码配置(更安全性能更优)。创建账号密码可使用:create login yesapi_dba with password='abcd1234@', default_database=TestDB;
db_hostStringRequired数据库域名或者IP地址
db_portIntRequired1433MIN: 1数据库端口,请确保此端口允许对外访问,或允许小白接口的IP白名单(联系小白技术客服索取)。如果需要使用非1433端口,需要提前将您的端口提供给小白技术客服进行设置。确保你的数据库服务器防火墙已开启1433端口,可使用:firewall-cmd --zone=public --add-port=1433/tcp --permanent; firewall-cmd --reload
db_charsetEnumOptaionUTF-8Range: UTF-8/936/GBK数据库编码,注意大小写。当前支持的编码有:
  • UTF-8
  • 936 简体中文GBK
查看当前数据库编码,可使用:SELECT COLLATIONPROPERTY('chinese_prc_ci_as', 'CodePage')
table_prefixStringOptaionMAX: 20统一表前缀
table_primary_keyStringOptaionidMAX: 20统一表主键名,要求每个表格都需要有主键自增的id字段,推荐统一在创建表时添加主键字段:id INT identity(1,1) NOT NULL PRIMARY KEY,例如:CREATE TABLE test_data (id INT identity(1,1) NOT NULL PRIMARY KEY, name VARCHAR(50), quantity INT)

API Debug

KEYREQUIREDVALUE
app_key *Required
db_mark *Required
db_name *Required
db_user *Required
db_password *Required
db_host *Required
db_port *Required
db_charset Option
table_prefix Option
table_primary_key Option

API Response

KEYTypeDescription
err_codeInt操作码,0成功,1数据库代号已存在,2添加失败
err_msgString错误提示信息,err_code非0时参考此提示信息

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