底层调用接口Client

November 23, 2021About 4 min

底层调用接口Client

SDK类名:/common/Client;

同步修改从类型节点

SDK方法名:updateSlaveNode;

URL

//api/client/update_slave_node

Method

POST

Request

名称类型必选初始值简介Mock规则
configString
cc_uuidString控制机uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。

获取所有虚拟平台

SDK方法名:getVirtualPlatforms;

URL

//api/client/get_virtual_platforms

Method

GET

Request

名称类型必选初始值简介Mock规则
npsvr_uuidStringnpsvr的uuid
cc_uuidString控制机uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  virtualPlatformsArray2
    uuidString414A7725-50AE-DCED-3F3C-9D8FC06CCB27

获取指定虚拟平台上的所有规则

SDK方法名:getVirtualPlatformRules;

URL

//api/client/get_virtual_platform_rules

Method

POST

Request

名称类型必选初始值简介Mock规则
vp_uuidsArray["3C334EF3"]一个或者多个虚拟平台。2
config_addrArray控制台地址,用来获取文件恢复规则
  String
cc_uuidString控制机uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  rulesArray
    uuidString414A7725-50AE-DCED-3F3C-9D8FC06CCB27

复制/NAS规则,创建比较结果

SDK方法名:createCompareResult;

URL

//api/client/create_compare_result

Method

POST

Request

名称类型必选初始值简介Mock规则
uuidString65DA3916-AF53-CE70-0B47-A142414AA140复制规则/nas规则 的uuid
result_uuidString25DA3916-AF13-CE70-0B47-B142414AA142比较结果uuid
result_typeStringrep规则类型:
rep,nas
resultObject比较结果
  codeString0任务执行结果code
  timeString10任务时间信息(start_time.'-'.end_time)
  filesString100总文件数量
  bytesString1111111总文件大小
  missingString2缺失文件数量
  diffString48不同文件数量
  equalString50相同文件数量
  erroString同步出错文件数量
cc_uuidString控制机uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。

接收比较与同步任务执行结果(租户 - 暂未用到)

SDK方法名:collectCompareResult

URL

//api/client/collect_compare_result

Method

POST

Request

名称类型必选初始值简介Mock规则
codeString任务执行结果code
start_timeString任务起始时间
end_timeString任务结束时间
filesString总文件数量
bytesString总文件大小
missingString缺失文件数量
diffString不同文件数量
equalString相同文件数量
erroString同步出错文件数量
task_uuidString比较任务uuid
cc_uuidString控制机uuid
send_bytesString已传输数据量

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  uuidString周期任务,由控制机生成的子任务的uuid

上传比较与同步执行差异详情

SDK方法名:uploadCompareDiffDetail

URL

//api/client/upload_diff_detail

Method

POST

Request

名称类型必选初始值简介Mock规则
filesArray可选,文件列表
missing_filesArray["file"]可选,缺失文件列表2
diff_filesArray可选,不同文件数列表
uuidString必填,实际执行任务uuid(可能是子任务)
cc_uuidString控制机uuid
is_newNumber0是否新建(清除旧数据):
0:否;
1:是;

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString

获取所有对象存储

SDK方法名:getDtoStorageList;

URL

//api/client/get_dto_storage_list

Method

GET

Request

名称类型必选初始值简介Mock规则
cc_uuidString控制机uuid

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  dto_storagesArray
    idNumber1数据库唯一主键id
    sto_uuidString存储uuid
    sto_nameString存储名称
    sto_typeNumber0存储类型
    addressString
    access_keyStringRSA加密
    secret_keyStringRSA加密
    part_sizeNumber0
    commentString
    random_strString
    user_uuidString
    usernameString
    create_timeNumber0
    userString
    pwdStringRSA加密
    remote_pathString
Last update: 6/25/2022, 9:23:18 PM
Contributors: ganl