YesApi 接口文档

5001 添加新数据库连接配置

接口路径(新)：http://api.yesapi.net/api/App/DB_MsSQL_Config/AddNewDatabaseConfig

接口路径(旧)：http://api.yesapi.net/?s=App.DB_MsSQL_Config.AddNewDatabaseConfig

接口描述： 添加新数据库连接配置，数据库必须是现有的数据库，或者需要开发者自己创建。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。
db_mark字符串必须数据库代号，对外暴露简短的数据库代号，避免数据库名字泄露。需要唯一指定，不能重复。
db_name字符串必须数据库名称。创建sql server数据库并设置编码，可使用：CREATE DATABASE TestDB; ALTER DATABASE TestDB collate chinese_prc_ci_as;
db_user字符串必须数据库账号，推荐单独创建新的数据库账号，可使用：USE TestDB; create user yesapi_dba for login yesapi_dba with default_schema=dbo; exec sp_addrolemember 'db_owner', 'yesapi_dba';
db_password字符串必须数据库密码，将采用RSA加密算法存储以确保密码的安全性。此外，推荐单独为小白接口创建独立的数据库账号，或者有需要可联系小白技术人员进行代码配置(更安全性能更优)。创建账号密码可使用：create login yesapi_dba with password='abcd1234@', default_database=TestDB;
db_host字符串必须数据库域名或者IP地址
db_port整型必须1433最小：1数据库端口，请确保此端口允许对外访问，或允许小白接口的IP白名单(联系小白技术客服索取)。如果需要使用非1433端口，需要提前将您的端口提供给小白技术客服进行设置。确保你的数据库服务器防火墙已开启1433端口，可使用：firewall-cmd --zone=public --add-port=1433/tcp --permanent; firewall-cmd --reload
db_charset枚举类型可选UTF-8范围：UTF-8/936/GBK数据库编码，注意大小写。当前支持的编码有：
  • UTF-8
  • 936 简体中文GBK
查看当前数据库编码，可使用：SELECT COLLATIONPROPERTY('chinese_prc_ci_as', 'CodePage')
table_prefix字符串可选最大：20统一表前缀
table_primary_key字符串可选id最大：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)

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 5001 添加新数据库连接配置】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Config.AddNewDatabaseConfig`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  添加新数据库连接配置，数据库必须是现有的数据库，或者需要开发者自己创建。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Config.AddNewDatabaseConfig` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 |  |
| token | string | 可选 |  |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| db_mark | string | 必填 | 数据库代号，对外暴露简短的数据库代号，避免数据库名字泄露。需要唯一指定，不能重复。 |
| db_name | string | 必填 | 数据库名称。创建sql server数据库并设置编码，可使用：CREATE DATABASE TestDB; ALTER DATABASE TestDB collate chinese_prc_ci_as; |
| db_user | string | 必填 | 数据库账号，推荐单独创建新的数据库账号，可使用：USE TestDB;         create user yesapi_dba for login yesapi_dba with default_schema=dbo;         exec sp_addrolemember 'db_owner', 'yesapi_dba'; |
| db_password | string | 必填 | 数据库密码，将采用RSA加密算法存储以确保密码的安全性。此外，推荐单独为小白接口创建独立的数据库账号，或者有需要可联系小白技术人员进行代码配置(更安全性能更优)。创建账号密码可使用：create login yesapi_dba with password='abcd1234@', default_database=TestDB; |
| db_host | string | 必填 | 数据库域名或者IP地址 |
| db_port | int | 必填 | 数据库端口，请确保此端口允许对外访问，或允许小白接口的IP白名单(联系小白技术客服索取)。如果需要使用非1433端口，需要提前将您的端口提供给小白技术客服进行设置。确保你的数据库服务器防火墙已开启1433端口，可使用：firewall-cmd --zone=public --add-port=1433/tcp --permanent; firewall-cmd --reload |
| db_charset | enum | 可选 | 数据库编码，注意大小写。当前支持的编码有：UTF-8936 简体中文GBK 查看当前数据库编码，可使用：SELECT  COLLATIONPROPERTY('chinese_prc_ci_as', 'CodePage') |
| table_prefix | string | 可选 | 统一表前缀 |
| table_primary_key | string | 可选 | 统一表主键名，要求每个表格都需要有主键自增的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) |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1数据库代号已存在，2添加失败|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Config.AddNewDatabaseConfig&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```
请求：
{你的接口域名}/?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"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1数据库代号已存在，2添加失败
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

5002 删除数据库配置

接口路径(新)：http://api.yesapi.net/api/App/DB_MsSQL_Config/RemoveDatabaseConfig

接口路径(旧)：http://api.yesapi.net/?s=App.DB_MsSQL_Config.RemoveDatabaseConfig

接口描述： 仅删除在小白接口配置的数据库配置信息，只会删除数据库配置，不会删除数据库，也不会删除数据库结构或数据。删除后小白接口将无法访问该直连数据库。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。
db_mark字符串必须需要删除的数据库代号。只会删除数据库配置，不会删除数据库，也不会删除数据库结构或数据。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 5002 删除数据库配置】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Config.RemoveDatabaseConfig`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  仅删除在小白接口配置的数据库配置信息，只会删除数据库配置，不会删除数据库，也不会删除数据库结构或数据。删除后小白接口将无法访问该直连数据库。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Config.RemoveDatabaseConfig` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 |  |
| token | string | 可选 |  |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| db_mark | string | 必填 | 需要删除的数据库代号。只会删除数据库配置，不会删除数据库，也不会删除数据库结构或数据。 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1数据库配置不存在|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Config.RemoveDatabaseConfig&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```
请求：
{你的接口域名}/?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"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1数据库配置不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

5003 编辑数据库配置

接口路径(新)：http://api.yesapi.net/api/App/DB_MsSQL_Config/EditDatabaseConfig

接口路径(旧)：http://api.yesapi.net/?s=App.DB_MsSQL_Config.EditDatabaseConfig

接口描述： 编辑更新数据库配置信息

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。
db_mark字符串必须数据库代号，待修改的数据库代号，必须先添加才能修改。
db_name字符串可选数据库名称，不传不修改
db_user字符串可选数据库账号，不传不修改
db_password字符串可选数据库密码，，不传不修改
db_host字符串可选数据库域名或者IP地址，不传不修改
db_port整型可选数据库端口，不传不修改，请确保此端口允许对外访问，或允许小白接口的IP白名单(联系小白技术客服索取)
db_charset枚举类型可选UTF-8范围：UTF-8/936/GBK数据库编码，不传不修改，注意大小写。当前支持的编码有：
  • UTF-8
db_enable布尔型可选数据库开关，不传不修改，1开0关
table_prefix字符串可选最大：20统一表前缀，不传不修改
table_primary_key字符串可选id最大：20统一表主键名，要求每个表格都需要有主键自增的id字段，不传不修改

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 5003 编辑数据库配置】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Config.EditDatabaseConfig`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  编辑更新数据库配置信息
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Config.EditDatabaseConfig` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 |  |
| token | string | 可选 |  |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| db_mark | string | 必填 | 数据库代号，待修改的数据库代号，必须先添加才能修改。 |
| db_name | string | 可选 | 数据库名称，不传不修改 |
| db_user | string | 可选 | 数据库账号，不传不修改 |
| db_password | string | 可选 | 数据库密码，，不传不修改 |
| db_host | string | 可选 | 数据库域名或者IP地址，不传不修改 |
| db_port | int | 可选 | 数据库端口，不传不修改，请确保此端口允许对外访问，或允许小白接口的IP白名单(联系小白技术客服索取) |
| db_charset | enum | 可选 | 数据库编码，不传不修改，注意大小写。当前支持的编码有：UTF-8 |
| db_enable | boolean | 可选 | 数据库开关，不传不修改，1开0关 |
| table_prefix | string | 可选 | 统一表前缀，不传不修改 |
| table_primary_key | string | 可选 | 统一表主键名，要求每个表格都需要有主键自增的id字段，不传不修改 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1数据库配置不存在|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Config.EditDatabaseConfig&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```
请求：
{你的接口域名}/?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"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1数据库配置不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

5004 获取全部数据库配置列表

接口路径(新)：http://api.yesapi.net/api/App/DB_MsSQL_Config/GetDatabaseConfigList

接口路径(旧)：http://api.yesapi.net/?s=App.DB_MsSQL_Config.GetDatabaseConfigList

接口描述： 返回全部全部数据库配置列表

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 5004 获取全部数据库配置列表】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Config.GetDatabaseConfigList`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  返回全部全部数据库配置列表
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Config.GetDatabaseConfigList` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 |  |
| token | string | 可选 |  |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Config.GetDatabaseConfigList&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```
请求：
{你的接口域名}/?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"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

5005 获取数据库配置

接口路径(新)：http://api.yesapi.net/api/App/DB_MsSQL_Config/GetDatabaseConfig

接口路径(旧)：http://api.yesapi.net/?s=App.DB_MsSQL_Config.GetDatabaseConfig

接口描述： 获取数据库配置，出于安全考虑，不会返回密码。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。
db_mark字符串必须数据库代号

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 5005 获取数据库配置】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Config.GetDatabaseConfig`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  获取数据库配置，出于安全考虑，不会返回密码。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Config.GetDatabaseConfig` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 |  |
| token | string | 可选 |  |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| db_mark | string | 必填 | 数据库代号 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0成功，1数据库配置不存在|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Config.GetDatabaseConfig&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1数据库配置不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次