YesApi 接口文档

5201 执行查询类的存储过程

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

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

接口描述： 在sql server中，执行预先定义的查询类存储过程。此类查询操作，只会进行数据的查询，不会进行数据的修改。最后返回查询的报表、数据或结果。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
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字符串必须直连数据库代号，注意！这是开发者添加的数据库代号，不是数据库的名称。使用API前请先添加新数据库连接配置。
proc_name字符串必须最小：1存储过程的名称，对应create proc [过程名称]。
pro_params字符串JSON格式可选[]存储过程的参数，没有时可不传。JSON格式，key对应参数名称，参数名称不需要在前面加@符号，注意参数类型(支持：字符串/整型/浮点型/NULL)，只支持一级参数。例如：{"name":"YesApi","quantity":666,"parent_id":null}

客户端请求示例

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

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


# 【 5201 执行查询类的存储过程】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Proc.QueryProc`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  在sql server中，执行预先定义的查询类存储过程。此类查询操作，只会进行数据的查询，不会进行数据的修改。最后返回查询的报表、数据或结果。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Proc.QueryProc` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| 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 | 必填 | 直连数据库代号，注意！这是开发者添加的数据库代号，不是数据库的名称。使用API前请先添加新数据库连接配置。 |
| proc_name | string | 必填 | 存储过程的名称，对应create proc [过程名称]。 |
| pro_params | array | 可选 | 存储过程的参数，没有时可不传。JSON格式，key对应参数名称，参数名称不需要在前面加@符号，注意参数类型(支持：字符串/整型/浮点型/NULL)，只支持一级参数。例如：{"name":"YesApi","quantity":666,"parent_id":null} |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| 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时参考此提示信息|
| data.result | array | 正常时，返回结果集数组。失败时返回null。|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Proc.QueryProc&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参数错误"
}
```
假设原来有数据：
1> use TestDB;
2> go
Changed database context to 'TestDB'.
1> select * from TestTable ;
2> go
id          name                                               quantity    parent_id   is_used    
----------- -------------------------------------------------- ----------- ----------- -----------
          4 小白V6hxh                                                     27        NULL           1
          5 小白接口V5hxh                                                  674           0           0
          6 小白V8hxh                                                     19           4           0
          7 小白V8hxh                                                     20           4           0
          8 小白V8hxh                                                    131           0           0
          9 小白接口V5hxh                                                  131           8           0
          10 小白接口V5hxh                                                   10           8           0
          13 中文123abc                                                    10        NULL           0
          14 中文123abc                                                    10        NULL           0
          15 中文123abc                                                    10        NULL           0

(10 rows affected)

并且预先定义了以下存储过程：
1> create proc sum_quantity_func
2> @start_quantity INT,
3> @end_quantity INT
4> as
5> begin
6>     select sum(quantity) AS total from TestTable where quantity>=@start_quantity and quantity<=@end_quantity
7> end
8> go

请求接口：
{你的接口域名}/?s=App.DB_MsSQL_Proc.QueryProc&db_mark=db_test&proc_name=sum_quantity_func&pro_params={"start_quantity":10,"end_quantity":20}&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "result": [
        {
            "total": "79"
        }
        ]
    },
    "msg": "V1.5.0 小白开放接口 App.DB_MsSQL_Proc.QueryProc"
}

接口返回

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

5202 调用命令类的存储过程

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

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

接口描述： 在sql server中，执行预先定义的命令类存储过程。此类命令操作，会进行数据的修改、增加、删除等副作用的操作。最后返回操作后的结果。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
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字符串必须直连数据库代号，注意！这是开发者添加的数据库代号，不是数据库的名称。使用API前请先添加新数据库连接配置。
proc_name字符串必须最小：1存储过程的名称，对应create proc [过程名称]。
pro_params字符串JSON格式可选[]存储过程的参数，没有时可不传。JSON格式，key对应参数名称，参数名称不需要在前面加@符号，注意参数类型(支持：字符串/整型/浮点型/NULL)，只支持一级参数。例如：{"name":"YesApi","quantity":666,"parent_id":null}

客户端请求示例

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

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


# 【 5202 调用命令类的存储过程】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.DB_MsSQL_Proc.ExecProc`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  在sql server中，执行预先定义的命令类存储过程。此类命令操作，会进行数据的修改、增加、删除等副作用的操作。最后返回操作后的结果。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.DB_MsSQL_Proc.ExecProc` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| 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 | 必填 | 直连数据库代号，注意！这是开发者添加的数据库代号，不是数据库的名称。使用API前请先添加新数据库连接配置。 |
| proc_name | string | 必填 | 存储过程的名称，对应create proc [过程名称]。 |
| pro_params | array | 可选 | 存储过程的参数，没有时可不传。JSON格式，key对应参数名称，参数名称不需要在前面加@符号，注意参数类型(支持：字符串/整型/浮点型/NULL)，只支持一级参数。例如：{"name":"YesApi","quantity":666,"parent_id":null} |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| 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时参考此提示信息|
| data.affected_rows | int | 正常时，返回影响的行数。失败时返回0。|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.DB_MsSQL_Proc.ExecProc&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参数错误"
}
```
假设原来有数据：
1> select * from TestTable where parent_id=6 or parent_id=5;
2> go
id          name                                               quantity    parent_id   is_used    
----------- -------------------------------------------------- ----------- ----------- -----------
          6 小白V8hxh                                                     19           5           0
          7 小白V8hxh                                                     20           5           0

(2 rows affected)

预先定义更新parent_id的存储过程为：
1> create proc update_parent_id_func
2> @new_parent_id INT,
3> @old_parent_id INT
4> as
5> begin
6>     update TestTable set parent_id=@new_parent_id where parent_id=@old_parent_id
7> end
8> go

请求：
{你的接口域名}/?s=App.DB_MsSQL_Proc.ExecProc&db_mark=db_test&proc_name=update_parent_id_func&pro_params={"new_parent_id":6,"old_parent_id":5}&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "result": 2
    },
    "msg": "V1.5.0 小白开放接口 App.DB_MsSQL_Proc.ExecProc"
}

重新查询：
1> select * from TestTable where parent_id=6 or parent_id=5;
2> go
id          name                                               quantity    parent_id   is_used    
----------- -------------------------------------------------- ----------- ----------- -----------
          6 小白V8hxh                                                     19           6           0
          7 小白V8hxh                                                     20           6           0

(2 rows affected)

接口返回

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

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