底层调用接口Client
November 23, 2021About 4 min
底层调用接口Client
SDK类名:/common/Client;
同步修改从类型节点
SDK方法名:updateSlaveNode;
URL
//api/client/update_slave_node
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
config | String | 否 | | | |
cc_uuid | String | | | 控制机uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | [0] 操作成功。 | | |
获取所有虚拟平台
SDK方法名:getVirtualPlatforms;
URL
//api/client/get_virtual_platforms
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
npsvr_uuid | String | 是 | | npsvr的uuid | |
cc_uuid | String | | | 控制机uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | [0] 操作成功。 | | |
virtualPlatforms | Array | 否 | | | 2 |
uuid | String | 否 | 414A7725-50AE-DCED-3F3C-9D8FC06CCB27 | | |
获取指定虚拟平台上的所有规则
SDK方法名:getVirtualPlatformRules;
URL
//api/client/get_virtual_platform_rules
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
vp_uuids | Array | 否 | ["3C334EF3"] | 一个或者多个虚拟平台。 | 2 |
config_addr | Array | | | 控制台地址,用来获取文件恢复规则 | |
| String | | | | |
cc_uuid | String | | | 控制机uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | [0] 操作成功。 | | |
rules | Array | 否 | | | |
uuid | String | 否 | 414A7725-50AE-DCED-3F3C-9D8FC06CCB27 | | |
复制/NAS规则,创建比较结果
SDK方法名:createCompareResult;
URL
//api/client/create_compare_result
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | | 65DA3916-AF53-CE70-0B47-A142414AA140 | 复制规则/nas规则 的uuid | |
result_uuid | String | | 25DA3916-AF13-CE70-0B47-B142414AA142 | 比较结果uuid | |
result_type | String | | rep | 规则类型: rep,nas | |
result | Object | | | 比较结果 | |
code | String | | 0 | 任务执行结果code | |
time | String | | 10 | 任务时间信息(start_time.'-'.end_time) | |
files | String | | 100 | 总文件数量 | |
bytes | String | | 1111111 | 总文件大小 | |
missing | String | | 2 | 缺失文件数量 | |
diff | String | | 48 | 不同文件数量 | |
equal | String | | 50 | 相同文件数量 | |
erro | String | | | 同步出错文件数量 | |
cc_uuid | String | | | 控制机uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | [0] 操作成功。 | | |
接收比较与同步任务执行结果(租户 - 暂未用到)
SDK方法名:collectCompareResult
URL
//api/client/collect_compare_result
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
code | String | 否 | | 任务执行结果code | |
start_time | String | 否 | | 任务起始时间 | |
end_time | String | | | 任务结束时间 | |
files | String | 否 | | 总文件数量 | |
bytes | String | 否 | | 总文件大小 | |
missing | String | 否 | | 缺失文件数量 | |
diff | String | 否 | | 不同文件数量 | |
equal | String | 否 | | 相同文件数量 | |
erro | String | 否 | | 同步出错文件数量 | |
task_uuid | String | 否 | | 比较任务uuid | |
cc_uuid | String | | | 控制机uuid | |
send_bytes | String | | | 已传输数据量 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | | | |
uuid | String | | | 周期任务,由控制机生成的子任务的uuid | |
上传比较与同步执行差异详情
SDK方法名:uploadCompareDiffDetail
URL
//api/client/upload_diff_detail
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
files | Array | 否 | | 可选,文件列表 | |
missing_files | Array | 否 | ["file"] | 可选,缺失文件列表 | 2 |
diff_files | Array | 否 | | 可选,不同文件数列表 | |
uuid | String | 否 | | 必填,实际执行任务uuid(可能是子任务) | |
cc_uuid | String | | | 控制机uuid | |
is_new | Number | | 0 | 是否新建(清除旧数据): 0:否; 1:是; | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | | | |
获取所有对象存储
SDK方法名:getDtoStorageList;
URL
//api/client/get_dto_storage_list
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
cc_uuid | String | | | 控制机uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | [0] 操作成功。 | | |
dto_storages | Array | | | | |
id | Number | | 1 | 数据库唯一主键id | |
sto_uuid | String | | | 存储uuid | |
sto_name | String | | | 存储名称 | |
sto_type | Number | | 0 | 存储类型 | |
address | String | | | | |
access_key | String | | | RSA加密 | |
secret_key | String | | | RSA加密 | |
part_size | Number | | 0 | | |
comment | String | | | | |
random_str | String | | | | |
user_uuid | String | | | | |
username | String | | | | |
create_time | Number | | 0 | | |
user | String | | | | |
pwd | String | | | RSA加密 | |
remote_path | String | | | | |