接口路径(新):http://api.okayapi.com/api/App/DB_MsSQL_Config/AddNewDatabaseConfig
接口路径(旧):http://api.okayapi.com/?s=App.DB_MsSQL_Config.AddNewDatabaseConfig
接口描述: 添加新数据库连接配置,数据库必须是现有的数据库,或者需要开发者自己创建。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
db_mark | String | Required | 数据库代号,对外暴露简短的数据库代号,避免数据库名字泄露。需要唯一指定,不能重复。 | ||
db_name | String | Required | 数据库名称。创建sql server数据库并设置编码,可使用:CREATE DATABASE TestDB; ALTER DATABASE TestDB collate chinese_prc_ci_as; | ||
db_user | String | Required | 数据库账号,推荐单独创建新的数据库账号,可使用:USE TestDB;
create user yesapi_dba for login yesapi_dba with default_schema=dbo;
exec sp_addrolemember 'db_owner', 'yesapi_dba'; | ||
db_password | String | Required | 数据库密码,将采用RSA加密算法存储以确保密码的安全性。此外,推荐单独为小白接口创建独立的数据库账号,或者有需要可联系小白技术人员进行代码配置(更安全性能更优)。创建账号密码可使用:create login yesapi_dba with password='abcd1234@', default_database=TestDB; | ||
db_host | String | Required | 数据库域名或者IP地址 | ||
db_port | Int | Required | 1433 | MIN: 1 | 数据库端口,请确保此端口允许对外访问,或允许小白接口的IP白名单(联系小白技术客服索取)。如果需要使用非1433端口,需要提前将您的端口提供给小白技术客服进行设置。确保你的数据库服务器防火墙已开启1433端口,可使用:firewall-cmd --zone=public --add-port=1433/tcp --permanent; firewall-cmd --reload |
db_charset | Enum | Optaion | UTF-8 | Range: UTF-8/936/GBK | 数据库编码,注意大小写。当前支持的编码有:
SELECT COLLATIONPROPERTY('chinese_prc_ci_as', 'CodePage') |
table_prefix | String | Optaion | MAX: 20 | 统一表前缀 | |
table_primary_key | String | Optaion | id | MAX: 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) |
请求:
{OKAYAPI_API_HOST}/?s=App.DB_MsSQL_Config.AddNewDatabaseConfig&db_mark=test&db_name=project_db&db_user=Admin&db_password=123456&db_host=120.100.100.100&db_port=1433&db_charset=UTF8&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V1.4.16 小白开放接口 App.DB_MsSQL_Config.AddNewDatabaseConfig"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0成功,1数据库代号已存在,2添加失败 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/App/DB_MsSQL_Config/RemoveDatabaseConfig
接口路径(旧):http://api.okayapi.com/?s=App.DB_MsSQL_Config.RemoveDatabaseConfig
接口描述: 仅删除在小白接口配置的数据库配置信息,只会删除数据库配置,不会删除数据库,也不会删除数据库结构或数据。删除后小白接口将无法访问该直连数据库。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
db_mark | String | Required | 需要删除的数据库代号。只会删除数据库配置,不会删除数据库,也不会删除数据库结构或数据。 |
请求:
{OKAYAPI_API_HOST}/?s=App.DB_MsSQL_Config.RemoveDatabaseConfig&db_mark=test&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V1.4.16 小白开放接口 App.DB_MsSQL_Config.RemoveDatabaseConfig"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0成功,1数据库配置不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/App/DB_MsSQL_Config/EditDatabaseConfig
接口路径(旧):http://api.okayapi.com/?s=App.DB_MsSQL_Config.EditDatabaseConfig
接口描述: 编辑更新数据库配置信息
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字段,不传不修改 |
请求:
{OKAYAPI_API_HOST}/?s=App.DB_MsSQL_Config.EditDatabaseConfig&db_mark=test&db_user=dogstar&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "V1.4.16 小白开放接口 App.DB_MsSQL_Config.EditDatabaseConfig"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0成功,1数据库配置不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/App/DB_MsSQL_Config/GetDatabaseConfigList
接口路径(旧):http://api.okayapi.com/?s=App.DB_MsSQL_Config.GetDatabaseConfigList
接口描述: 返回全部全部数据库配置列表
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY |
请求:
{OKAYAPI_API_HOST}/?s=App.DB_MsSQL_Config.GetDatabaseConfigList&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"config_list": [
{
"db_mark": "test",
"db_host": "22",
"db_port": 1433,
"db_user": "dogstar",
"db_name": "haha",
"db_enable": 1,
"db_charset": "UTF8"
},
{
"db_mark": "dogstar_test_edit",
"db_host": "x1582706619",
"db_port": 1321,
"db_user": "testuser",
"db_name": "name",
"db_enable": 1,
"db_charset": "xxx"
}
]
},
"msg": "V1.4.16 小白开放接口 App.DB_MsSQL_Config.GetDatabaseConfigList"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/App/DB_MsSQL_Config/GetDatabaseConfig
接口路径(旧):http://api.okayapi.com/?s=App.DB_MsSQL_Config.GetDatabaseConfig
接口描述: 获取数据库配置,出于安全考虑,不会返回密码。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
db_mark | String | Required | 数据库代号 |
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0成功,1数据库配置不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York May/02/2024 20:04:34