# DTO

SDK类名:/dto/Dto

# 存储 - 新建

SDK方法名:createDtoStorage;

# URL

//dto/storage

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
sto_name String 名称
sto_type Number 0 存储类型:

0:LocalFS; 1:AWS S3; 2:S3 Compatible; 3:Aliyun OSS; 4:Baidu BOS; 5:MS Azure File; 6:MS Azure Blob; 7:Jingdong OSS; 8:Ftp服务器; 9: swift | address | String | 否 | | 存储访问地址,云存储时传;FTP地址,IP/Domain:Port,FTP服务器时传 | access_key | String | 否 | | Access Key,RSA加密发送,云存储时传 | secret_key | String | 否 | | Secret Key,RSA加密发送,云存储时传 | part_size | Number | 否 | 0 | 大文件分片大小,云存储时传 | user | String | 否 | | FTP用户名,FTP服务器时传 | pwd | String | 否 | | FTP密码,RSA加密发送,FTP服务器时传 | remote_path | String | 否 | | FTP远程路径,多个路径用 “.” 连接,FTP服务器时传 | comment | String | 否 | | 可选,说明 |

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 存储 - 修改

SDK方法名:modifyDtoStorage;

URL 参数为:sto_uuid;

# URL

//dto/storage/:uuid([A-F0-9-]+)

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
sto_name String
address String
access_key String
secret_key String
part_size Number 0
user String
pwd String
remote_path String
comment String
random_str String

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 存储 - 单个

SDK方法名:describeDtoStorage;

# URL

//dto/storage/:uuid([A-F0-9-]+)

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  dto_storage Object
    sto_uuid String
    sto_name String
    sto_type Number 0
    address String
    access_key String RSA密文,需要前端解密,默认显示
    secret_key String RSA密文,需要前端解密,并且默认隐藏,点击输入框后显示
    part_size Number 0
    user String
    pwd String
    remote_path String
    comment String
    random_str String
    user_uuid String
    username String
    create_time Number 0

# 存储 - 列表

SDK方法名:listDtoStorage;

# URL

//dto/storage

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 1
page Number 1
search_value String
search_field String

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  total Number 1
  info_list Array
    sto_uuid String 343
    sto_name String 1
    sto_type Number 0
    address String 4
    user_uuid String
    username String
    create_time Number 0

# 存储 - 删除

SDK方法名:deleteDtoStorage;

# URL

//dto/storage

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
sto_uuids Array ["11111111-1111-1111-1111-111111111111"]

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# ----------------------

# URL

/dash_3

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则

# 主机 - 认证

SDK方法名:authDtoHost;

# URL

//dto/host/auth

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
host_ip String 192.168.72.70 地址
host_user String exampleuser 认证用户名
host_pwd String dN5BejxqJsnEQOBRig7OBeZzQb1SEYAfs0keD+6z1l658pc/drceaMJa29FDdQpW6FfLLmb1cG1DWvOOGz9sZRUY4wnKNhpHQjVE4wAlLOnVZPGlYSgtURhbIOeLl5uZCWgCSGTbQFMTCD/wql4/8/cMgWspQBvwO/5UbYqcW64Sj8wnuWf6qt4KGqrP9ua2yDFj+5S0MgMLWnAXhBwCCFVBmmmngNr5CUMe4Hqm1/d4OhvTzqTWecLNFnr9NmN4fp1zAQMZstUiedgWGg7uU9Aez2Xf8RsekMeo3O7bnZXyHZL5wpOtiq3gD/12H4bNrgDYuShsGDfEEqzfwXpoew== 认证密码,RSA加密

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 主机 - 新建

SDK方法名:createDtoHost;

# URL

//dto/host

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
host_name String 名称
host_ip String 地址
host_user String 认证用户名
host_pwd String 认证密码,RSA加密
comment String 说明
sto_uuid String CCF36C5F-CBA6-8A55-3CA2-C07CF8E0EC4F 目标存储

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 主机 - 修改

SDK方法名:modifyDtoHost;

URL 参数为:host_uuid;(是建立主机时生成的)

# URL

//dto/host/:uuid([A-F0-9-]+)

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
host_uuid String
host_name String
host_ip String
host_user String
host_pwd String
sto_uuid Number 0
random_str String

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 主机 - 单个

SDK方法名:describeDtoHost;

# URL

//dto/host/:uuid([A-F0-9-]+)

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  dto_host Object
    host_uuid String 123123123
    host_name String
    host_type Number 0
    host_ip String
    host_user String
    host_pwd String
    comment String
    sto_uuid String
    random_str String
    user_uuid String
    username String
    create_time Number 0
    os_type Number 0 系统: 0: linux, 1: windows

# 主机 - 列表

SDK方法名:listDtoHost;

# URL

//dto/host

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 1
page Number 1
search_value String
search_field String

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  total Number 1
  info_list Array
    host_uuid String 11111111 新建时生成的主机uuid
    host_name String
    host_type Number 0
    host_ip String
    sto_uuid String 00000000
    sto_type String
    sto_name String
    sto_type Number
    user_uuid String
    username String
    create_time Number 0
    os_type Number 0 系统: 0: linux, 1: windows
    can_op Number 1 1
    can_up Number 1 1

# 主机 - 状态

SDK方法名:listDtoHostStatus;

# URL

//dto/host/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
host_uuids Array

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功
  status Array
    status String ONLINE 在线:ONLINE;离线:OFFLINE;
    host_uuid String
    version String 版本

# 主机 - 删除

SDK方法名:deleteDtoHost;

# URL

//dto/host

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
host_uuids Array

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功

# 主机 - 归档时间范围

SDK方法名:listArchiveDate; URL参数:host_uuid;

说明:点主机列表操作栏“查看归档文件”后,先调这个接口获取可选时间范围,获取到了就作为参数调【归档文件列表】,获取不到报错了就别调文件列表了;

# URL

//dto/host/:uuid([A-F0-9-]+)/archive_date

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  os_type Number
  date_list Array 这个可能为空数组,就不调获取文件列表了 4
    default_begin_date Number 1562515200 默认开始时间,最长为三月前
    begin_date Number 1562515200 用来约束 搜索的时间范围
    end_date Number 1563638399 用来约束 搜索的时间范围
    year String 2019

# 主机 - 归档文件列表

SDK方法名:listArchiveFile; URL参数:host_uuid;

# URL

//dto/host/:uuid([A-F0-9-]+)/archive_file

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
data_source String 2019 数据时间源,就是归档时间范围的year
page Number 1 分页
limit Number 100 分页,默认100,暂禁止修改
wk_path String 可选搜索条件,工作路径(同步主机上的路径)
file_name String 可选搜索条件,文件名,模糊搜索
create_begin_time Number 可选搜索条件,时间戳
create_end_time Number 可选搜索条件,时间戳
modify_begin_time Number 可选搜索条件,时间戳
modify_end_time Number 可选搜索条件,时间戳

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  total Number 1000
  info_list Array
    id Number 123
    wk_path String /test/
    bk_path String /test2/
    file_create_time String 2019-08-06
    file_modify_time String 2019-08-06
    file_delete_time String 2019-08-06

# 主机 - 底层加载规则

URL 参数:host_uuid;

调的时候前面的IP是控制机IP;

返回结果先判断HTTP状态码,200为正常,再判断data里的code,0为正常;

示例URL:https://172.20.79.69:58086/api/dto/host/790502A5-F563-4E22-8E64-692713FDE812/load_rules,无请求参数,返回示例如下;

# URL

//dto/host/:uuid([A-F0-9-]+)/load_rules

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功

# 主机 - 查看备份记录

# URL

//dto/host/:uuid([A-F0-9-]+)/backup_record

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
file_name String 文件名
wk_path String 源路径
bk_path String 目标存储
begin_backup_time Number 起始备份时间
end_backup_time Number 截止备份时间
page String 1 页码
limit String 100 每页记录条数,默认100

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  total Number 1 记录总数
  info_list Array 记录列表
    file_name String 文件名
    wk_path String 源路径
    bk_path String 目标存储
    create_time Number 创建时间
    modify_time Number 文件修改时间
    backup_time Number 备份时间
    id String 唯一标识一条记录

# 主机 - 操作

# URL

//dto/host/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
host_uuids Array 主机uuid
operate String 操作名称:upgrade

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object
  code Number 0
  message String success
ret Number 200
msg String

# ----------------------

# URL

/dash_2

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则

# 规则 - 新建

SDK方法名:createDtoRule;

# URL

//dto/rule

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
enable Number 0 是否启用:0否1是
rule_name String 名称
rule_type Number 0 规则类型:0:同步规则;1:恢复规则;2:比较规则;
sync_type Number 同步类型:1:静态同步;2:动态同步;3:仅比较;4:比较并同步;5:FTP比较并同步;(旧:规则类型)
policy_type Number 0 同步策略类型:0:手动同步;1:定期同步;2:间隔同步;
policy_str String 同步策略定义:(星期天为0)

1)当同步策略为“手动同步”时,该项为空; 2)当同步策略为“定期同步”时,该项定义如下(||前后都有空格): D::1,2,3=8:00,9:00,10:00 || D::5,6,7=0:00 || W::1,2,3,4,5,6=0:00,2:00 意思是:每月的1,2,3号的8:00,9:00,10:00以及每月的5,6,7号的0:00以及周1,2,3,4,5,6的0:00,2:00,规则自动开启运行;周日用0表示。 3)当同步策略为“间隔同步”时,该项定义如下: I::2016-08-10 17:00:00=2 意思是:从2016年8月10日17:00:00开始,每间隔2分钟规则自动开启运行;最小间隔时间为1分钟。 | sync_uuid | String | 否 | | 同步机uuid | wk_uuid | String | 否 | | (比较)比较源存储(FTP比较同步时只能用FTP服务器) | wk_path | Array | 否 | | 同步规则时为源路径(同步机上的路径), 还原时为目标路径(同步机上的路径), 比较时为源路径(源存储上的路径) | bk_uuid | String | 否 | | (还原、比较)比较的目标存储uuid,还原的源存储(FTP比较同步时只能用本地存储) | bk_path | Array | 否 | | 同步规则时为目标路径(目标存储上的路径), 还原时为源路径(源存储上的路径), 比较时为目标路径(目标存储上的路径) | excl_path | Array | 否 | | 排除路径 | file_type_filter_switch | Number | 否 | 0 | 文件后缀名过滤,1 包含,2 排除 | file_type_filter | String | 否 | | 以后缀名为过滤条件,格式为“.文件扩展名”;若多个过滤条 件则用逗号隔开,如:.txt,.doc,.rtf | compare_type | Number | 否 | 0 | (同步、比较)比较类型:0: 文件属性校验(大小+修改时间);1:MD5校验;2:文件大小;3:对象智能比对(需要存储支持自定义META) ; | oph_policy | Number | 否 | 0 | (比较)孤儿文件处理方式:0:不处理;1:确认后删除;2:直接删除 | bk_name_opt | Number | 否 | 0 | (同步)对象文件路径名:0:和源端保持不变;1:全部为大写;2:全部为小写; | trans_thread_num | Number | 否 | 0 | 传输线程数量,1-100 | obj_scan_thread_num | Number | 否 | 0 | (还原、比较)对象存储扫描线程数量,1-10 | cmp_thread_num | Number | 否 | 0 | (比较)比对线程数量 | cmp_algorithm | Number | 否 | 0 | (比较)比对算法,1:小目录先扫描后比对;2:大目录边扫描边比对(页面上暂不显示,传死值1) | cmp_result_limit | Number | 否 | 0 | (比较)保留结果数量 | band_width | String | 否 | | (同步、比较)带宽设置;

周几几几几点-几点限速(单位k/m);如

1234508:00-18:00100m,0500:00-23:00200k

,意为,周一到周五8点到18点限速100m,周日和周五0点到23点限速200k | app_db_up_switch | Number | 否 | 0 | (同步)是否启用映射更新,0否1是 | app_db_up_type | String | 否 | 0 | (同步)应用数据库类型:Oracle / SQLServer | app_db_up_sql | String | 否 | 0 | (同步)更新映射的SQL语句 | archive_flag | Number | 否 | 1 | (比较)是否启用归档,0关1开,

归档只有在 孤儿文件处理方式、压缩、加密 都关闭的情况下才能开启;

归档只支持本地存储到对象存储; | archive_type | Number | 否 | 1 | (比较)归档类型,0:同步所有文件,并删除本地符合条件的文件;1:只同步并删除符合条件的文件,默认0 | archive_days | Number | 否 | 1 | (比较)归档条件,创建时间和修改时间早于同步时间的天数,默认90 | compress | Number | 否 | 0 | 压缩(同步)、解压(还原)开关,0关1开;只有比较类型为:对象智能比对(需要存储支持自定义META) 、忽略目标端存在的文件 时可以开启; | encrypt | Number | 否 | 0 | 加密(同步)、解密(还原)开关,0关1开;只有比较类型为:对象智能比对(需要存储支持自定义META) 、忽略目标端存在的文件 时可以开启; | encrypt_pass | String | 否 | | 加密(同步)、解密(还原)密码,需要加密; |

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 规则 - 修改

SDK方法名:modifyDtoRule;

URL 参数为:rule_uuid;

# URL

//dto/rule/:uuid([A-F0-9-]+)

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
enable Number 0
rule_name String
sync_uuid String
policy_type Number 0
policy_str String
wk_uuid String
wk_path Array
bk_uuid String
bk_path Array
excl_path Array
file_type_filter_switch Number 0
file_type_filter String
compare_type Number 0
oph_policy Number 0
bk_name_opt Number 0
trans_thread_num Number 0
obj_scan_thread_num Number 0
cmp_thread_num Number 0
cmp_algorithm Number 0
cmp_result_limit Number 0
band_width String
app_db_up_switch Number 0
app_db_up_type Number 0
app_db_up_sql Number 0
random_str String
sync_type Number
archive_flag Number 1
archive_type Number 1
archive_days Number 1
compress Number 0
encrypt Number 0
encrypt_pass String

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 规则 - 单个

SDK方法名:describeDtoRule;

# URL

//dto/rule/:uuid([A-F0-9-]+)

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  dto_rule Object
    enable Number 0
    rule_uuid String
    rule_name String
    rule_type Number 0
    sync_uuid String
    sync_name String
    policy_type Number 1
    policy_str String
    wk_uuid String
    wk_name String
    wk_path Array
    bk_uuid String
    bk_name String
    bk_path Array
    excl_path Array
    file_type_filter_switch Number 0
    file_type_filter String
    compare_type Number 0
    oph_policy Number 0
    bk_name_opt Number 0
    trans_thread_num Number 0
    obj_scan_thread_num Number 0
    cmp_thread_num Number 0
    cmp_algorithm Number 0
    cmp_result_limit Number 0
    band_width String
    app_db_up_switch Number 1
    app_db_up_type String Oracal
    app_db_up_sql String test
    random_str String
    user_uuid String
    username String
    create_time Number 0
    sync_type Number

# 规则 - 列表

SDK方法名:listDtoRule;

# URL

//dto/rule

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
type Number 规则类型:0:同步规则;1:恢复规则;2:比较规则;
limit Number 1
page Number 1
search_value String
search_field String

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。
  total Number 1
  info_list Array
    enable Number 0
    rule_uuid String 9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
    rule_name String
    rule_type Number 0
    sync_uuid String
    user_uuid String
    username String
    create_time Number 0
    sync_type Number
    wk_sto_name String
    bk_sto_name String
    sync_host_name String

# 规则 - 状态

SDK方法名:listDtoRuleStatus;

# URL

//dto/rule/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
rule_uuids Array

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功
  status Array
    rule_uuid String 9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
    status String ORPHAN 规则状态,NOT_STARTED(未启动)/ ORPHAN(孤儿文件处理中)/ STOP / FINISH / EXCEPTION / COMPARING / UNKNOWN
    progress String 50 百分比=read_bytes/total_bytes
    total_bytes Number 0 总字节数
    trans_bytes Number 0 传输字节数
    read_bytes Number 0
    total Number 0 文件总数
    trans Number 0 传输文件数
    same Number 0 相同文件数
    miss Number 0 缺失文件数
    diff Number 0 不同文件数
    fail Number 0 传输失败数

# 规则 - 删除

SDK方法名:deleteDtoRule;

# URL

//dto/rule

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
rule_uuids Array

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 规则 - 操作

SDK方法名:{operate}DtoRule;

# URL

//dto/rule/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String 启动:start;停止:stop;继续:resume;
rule_uuids Array

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功。

# 规则 - 文件列表(比较 不同/丢失/失败/孤儿)

SDK方法名:listDtoRuleFile; URL 参数为:rule_uuid;

# URL

//dto/rule/:uuid([A-F0-9-]+)/file

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
type String 参数:diff/miss/fail/orphan
page Number
limit Number

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功
  total Number 1
  info_list Array
    path String / 某路径下。。
    files String 2 。。有什么文件(逗号分隔)
    more Number 如果files中多于1000个,则more值为一共多少个,否则more为0

# 规则 - 文件列表 删除孤儿(比较)

SDK方法名:deleteDtoRuleFile; URL 参数为:rule_uuid;

# URL

//dto/rule/:uuid([A-F0-9-]+)/file

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功

# 规则 - 比较结果(比较)

SDK方法名:listDtoRuleCmpResult; URL 参数为:rule_uuid;

# URL

//dto/rule/:uuid([A-F0-9-]+)/cmp_result

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 200
msg String
data Object
  code Number 0
  message String [0] 操作成功
  info_list Array
    id Number 1
    total Number 0 总文件数
    same Number 0 丢失文件数
    miss Number 1 丢失文件数
    diff Number 0 不同文件数
    trans Number 1 传输文件数
    fail Number 1 失败文件数
    trans_bytes Number 0 传输字节数
    status String FINISH IDEL / STOP / FINISH / EXCEPTION
    start_time Number 1557398375 时间戳
    finish_time Number 1557398381 时间戳
    wk_path Array ["aliyun--oos:/TestDir/222 - 副本 (4).txt"] 执行时源路径
    bk_path Array ["aliyun--oos:/TestDir/222 - 副本 (5).txt"] 执行时目标路径
    excl_path Array [] 执行时排除路径
Last Updated: 5/13/2020, 3:56:32 AM