接口路径(新):http://hn216.api.okayapi.com/api/App/DB_MsSQL_Proc/QueryProc
接口路径(旧):http://hn216.api.okayapi.com/?s=App.DB_MsSQL_Proc.QueryProc
接口描述: 在sql server中,执行预先定义的查询类存储过程。此类查询操作,只会进行数据的查询,不会进行数据的修改。最后返回查询的报表、数据或结果。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 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 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
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表示服务端异常,查看异常错误码 |
data | object/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密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/DB_MsSQL_Proc/ExecProc
接口路径(旧):http://hn216.api.okayapi.com/?s=App.DB_MsSQL_Proc.ExecProc
接口描述: 在sql server中,执行预先定义的命令类存储过程。此类命令操作,会进行数据的修改、增加、删除等副作用的操作。最后返回操作后的结果。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 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 客户端接入指南(如何生成签名) 开启/关闭签名
假设原来有数据:
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表示服务端异常,查看异常错误码 |
data | object/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密钥字符串) ,若需要关闭或开启请提交工单 |
特别注意:当前 hn216.api.okayapi.com 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次