客户端HTTP接口调用
该章节介绍客户端http接口调用使用
1.文件同步发送接口
接口说明: 通过该接口可同步向接收代理服务器发送文件
URL: POST ip:port/client/send/syn
发送报文：
{
"address": ["127.0.0.1:7081"],
"sendfolder":"F:/BFT/BFT75GA/folder/send/20221120",
"recfolder": "F:/BFT/BFT75GA/folder/rec/20221120",
"filelist": ["F:/BFT/BFT75GA/folder/send/20221120/b20221128.sql"]
}
参数说明:
| 参数 | 说明 | 备注 |
|---|---|---|
| address | 接收代理服务器地址List |
必填 |
| sendfolder | 发送节点发送目录 | 选填，sendfolder、files必须填写一项 |
| recfolder | 接收代理服务器接收文件目录 | 必填 |
| filelist | 发送文件集合,类型List |
可选，若为空则传输发送目录下所有文件 |
返回报文：
{
"code": 0,
"message": "成功","data": {
"duration": "0天0时0分5秒",
"totalsize": 1,
"endDate": "2022-12-26 14:45:48.466",
"failsize": 0,
"succsize": 1,
"startDate": "2022-12-26 14:45:43.440"
}
}
返回报文字段说明:
| 参数 | 说明 |
|---|---|
| code | 执行状态码 0：失败 1：成功 |
| message | 消息 |
| totalsize | 读取文件数 |
| succsize | 传输成功文件数 |
| failsize | 传输失败文件数 |
| starttime | 开始时间 |
| endtime | 结束时间 |
| duration | 传输时长 |
2.文件异步发送接口
接口说明: 通过该接口可异步向接收代理服务器发送文件
URL: POST ip:port/client/send/asyn
发送报文：
{
"address": ["127.0.0.1:7081"],
"sendfolder":"F:/BFT/BFT75GA/folder/send/20221120",
"recfolder": "F:/BFT/BFT75GA/folder/rec/20221120",
"filelist": ["F:/BFT/BFT75GA/folder/send/20221120/b20221128.sql"]
}
参数说明:
| 参数 | 说明 | 备注 |
|---|---|---|
| address | 接收代理服务器地址List |
必填 |
| sendfolder | 发送节点发送目录 | 选填，sendfolder、files必须填写一项 |
| recfolder | 接收代理服务器接收文件目录 | 必填 |
| files | 发送文件集合,类型List |
可选，若为空则传输发送目录下所有文件 |
返回报文:
{
"code": 0,
"message": "SUCCEED",
"data": "a1e8aaa1319a448d9ef9c4502e95481e"
}
返回报文字段说明:
| 参数 | 说明 |
|---|---|
| code | 执行状态码 0：成功1： 失败 |
| message | 消息 |
| data | 异步执行结果查询码用于异步执行结果查询 |
3.文件异步发送结果查询接口
接口说明: 通过该接口可同步向接收代理服务器发送文件
URL: get ip:port/client/result/query?requestid={requestid}
参数说明:
| 参数 | 说明 | 备注 |
|---|---|---|
| requestid | 异步执行返回的异步查询码 | 必填 |
返回报文：
{
"code": 0,
"message": "成功",
"data": {
"duration": "0天0时0分5秒",
"totalsize": 1,"endDate": "2022-12-26 14:45:48.466",
"failsize": 0,
"succsize": 1,
"startDate": "2022-12-26 14:45:43.440"
}
}
返回报文字段说明：
| 参数 | 说明 |
|---|---|
| code | 执行状态码 0：失败 1：成功 |
| message | 消息 |
| totalsize | 读取文件数 |
| succsize | 传输成功文件数 |
| failsize | 传输失败文件数 |
| starttime | 开始时间 |
| endtime | 结束时间 |
| duration | 传输时长 |
4.文件同步接收接口
接口说明: 通过该接口可同步从发送代理服务器接收文件
URL: POST ip:port/client/receive
发送报文：
{
"address": ["127.0.0.1:7081"],
"sendfolder":"F:/BFT/BFT75GA/folder/send/20221120",
"recfolder": "F:/BFT/BFT75GA/folder/rec/20221120",
"filelist": ["F:/BFT/BFT75GA/folder/send/20221120/b20221128.sql"]
}
参数说明:
| 参数 | 说明 | 备注 |
|---|---|---|
| address | 发送代理服务器地址List |
必填 |
| sendfolder | 发送代理服务器发送目录 | 选填，sendfolder、files必须填写一项 |
| recfolder | 当前服务器接收文件目录 | 必填 |
| filelist | 发送文件集合,类型List |
可选，若为空则传输发送目录下所有文件 |
返回报文：
{
"code": 0,
"message": "成功",
"data": {
"duration": "0天0时0分5秒",
"totalsize": 1,
"endDate": "2022-12-26 14:45:48.466",
"failsize": 0,
"succsize": 1,
"startDate": "2022-12-26 14:45:43.440"
}
}
返回报文字段说明：
| 参数 | 说明 |
|---|---|
| code | 执行状态码 0：失败 1：成功 |
| message | 消息 |
| totalsize | 读取文件数 |
| succsize | 传输成功文件数 |
| failsize | 传输失败文件数 |
| starttime | 开始时间 |
| endtime | 结束时间 |
| duration | 传输时长 |