DTO主机
SDK类名:/dto/DtoHost
主机 - 认证
SDK方法名:authDtoHost;
URL
Method
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
Method
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 | 目标存储 | |
cc_ip | String | | | 控制机地址 | |
cc_ip_uuid | String | | | 控制机地址uuid | |
maintenance | Number | | 0 | | |
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
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
host_uuid | String | 否 | | | |
host_name | String | 否 | | | |
host_ip | String | 否 | | | |
host_user | String | 否 | | | |
host_pwd | String | 否 | | | |
sto_uuid | Number | 否 | 0 | | |
random_str | String | 否 | | | |
cc_ip | String | | | | |
cc_ip_uuid | String | | | | |
maintenance | Number | | 0 | | |
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
Request
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 | |
cc_ip | String | | | | |
cc_ip_uuid | String | | | | |
主机 - 列表
SDK方法名:listDtoHost;
URL
Method
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 | 否 | test | | |
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 |
can_del | Number | | | | 1 |
主机 - 状态
SDK方法名:listDtoHostStatus;
URL
Method
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
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
host_uuids | Array | 否 | | | |
force | Number | | | 1 - 强制删除 0 - 非强制删除 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
msg | String | | | | |
data | Object | | | | |
code | Number | | 11110001 | | |
message | String | | | | |
fail_list | Array | | | | |
code | Number | | 11110001 | | |
message | String | | [-1] 离线 | | |
host_uuid | String | | @guid | | |
host_name | String | | test2 | | |
success_list | Array | | | | |
code | Number | | 11110001 | | |
message | String | | [0] success | | |
host_uuid | String | | @guid | | |
host_name | String | | test1 | | |
ret | Number | | 200 | | |
主机 - 归档时间范围
SDK方法名:listArchiveDate; URL参数:host_uuid;
说明:点主机列表操作栏“查看归档文件”后,先调这个接口获取可选时间范围,获取到了就作为参数调【归档文件列表】,获取不到报错了就别调文件列表了;
URL
//dto/host/:uuid([A-F0-9-]+)/archive_date
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
type | Number | | 0 | 0:归档;1:回源 | |
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方法名:listRcTimePoint;
URL
//dto/host/:uuid([A-F0-9-]+)/rc_time_point
Method
Request
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | [0] 操作成功。 | | |
list | Array | | | | |
time | Number | | 1562515200 | 精确到毫秒 | |
主机 - 归档文件列表
SDK方法名:listArchiveFile; URL参数:host_uuid;
URL
//dto/host/:uuid([A-F0-9-]+)/archive_file
Method
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 | | |
主机 - 底层加载规则
SDK方法名:listLoadRules;
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
Request
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | [0] 操作成功 | | |
主机 - 查看备份记录
SDK方法名:listBakRecord;
URL
//dto/host/:uuid([A-F0-9-]+)/backup_record
Method
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 | 否 | | 唯一标识一条记录 | |
主机 - 操作
SDK方法名:operateDtoHost;
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
host_uuids | Array | 否 | | 主机uuid | |
operate | String | 否 | | 操作名称:upgrade,maintain | |
switch | Number | | 0 | 维护模式,0关,1开 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | success | | |
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
主机 - 回源
SDK方法名:revertFile;
URL
//dto/host/:uuid([A-F0-9-]+)/revert_file
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
data_source | String | | 2021 | 年份 | |
ids | Array | | | | |
| String | | | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
data | Object | | | | |
code | Number | | 0 | | |
message | String | | success | | |
ret | Number | | 200 | | |
msg | String | | | | |
主机 - 获取回源记录
SDK方法名:listRevertRecord;
URL
//dto/host/:uuid([A-F0-9-]+)/revert_record
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
data_source | String | | 2019 | 年份 | |
wk_path | String | | | 源路径 | |
file_name | String | | | 文件名 | |
create_begin_time | Number | 否 | 1 | 起始时间 | |
create_end_time | Number | | 1 | 结束时间 | |
page | Number | | 1 | 页数 | |
limit | Number | | 100 | 条数 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | [0] 操作成功。 | | |
total | Number | | 1000 | | |
info_list | Array | | | | |
wk_path | String | | /test/ | 源路径 | |
bk_path | String | | /test2/ | 目标路径 | |
revert_time | Number | | | 回源时间 | |
result | String | | SUCCESS | 结果。SUCCESS、FAILED | |
reason | String | | 123 | 失败原因 | |