DTO主机

SDK类名：/resource/DtoHost

主机 - 认证

SDK方法名：authDtoHost;

URL

/dto/host/auth

Method

POST

Request

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

Response

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

主机 - 新建

SDK方法名：createDtoHost;

URL

/dto/host

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_name	String	否	名称
host_ip	String	否	地址
host_port	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
host_type	Number
maintenance	Number		维护模式：0：关，1：开	0
host_cluster_type	String		主机类型（与底层保持一致），1：单机，2：集群
syncdb_host	String		数据库地址
syncdb_port	String		数据库端口
syncdb_name	String		数据库名
syncdb_username	String		数据库用户名
syncdb_password	String		数据库密码
syncdb_type	Number		数据库类型，0：代表sqlite（单机主机表示本地数据库），1：代表TDSQL（集群主机可选）
node_list	Array		集群节点列表
address	String		地址
port	String		端口
uuid	String		uuid

Response

名称	类型	必选	简介	Mock初始值	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初始值	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初始值	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初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	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: linux, 1: windows	0
cc_ip	String
cc_ip_uuid	String

主机 - 列表

SDK方法名：listDtoHost;

URL

/dto/host

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
total	Number	否		1
info_list	Array	否
host_uuid	String	否	新建时生成的主机uuid	11111111
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: linux, 1: windows	0
can_op	Number	否		1	1
can_up	Number	否		1	1
can_del	Number				1

主机 - 状态

SDK方法名：listDtoHostStatus;

URL

/dto/host/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_uuids	Array	否
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
status	Array	否
status	String	否	在线：ONLINE；离线：OFFLINE；	ONLINE
host_uuid	String	否
version	String	否	版本
host_cluster_type	String		是否为集群
nodes	Array
port	String
uuid	String		节点uuid
status	String		节点状态，ONLINE,OFFLINE
address	String		地址

主机 - 删除

SDK方法名：deleteDtoHost;

URL

/dto/host

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_uuids	Array	否
force	Number		1 - 强制删除 0 - 非强制删除

Response

名称	类型	必选	简介	Mock初始值	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方法名：listDtoHostClusterNode;

URL

/dto/host/node

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
where_args[host_uuid]	String		DTO主机uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
info_list	Array			10
node_uuid	String		集群节点uuid
host_uuid	String		DTO主机uuid
address	String		地址
port	String		端口
status	String		状态
user_uuid	String		用户uuid
create_time	String		创建时间
ret	Number			200

主机 - 删除集群节点

SDK方法名：deleteDtoHostClusterNode;

URL

/dto/host/node

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		DTO节点uuid

Response

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

主机 - 归档时间范围

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

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

URL

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

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number		0：归档；1：回源	0

Response

名称	类型	必选	简介	Mock初始值	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

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	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

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
data_source	String	是	数据时间源，就是归档时间范围的year	2019
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初始值	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

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	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

GET

Request

名称	类型	必选	简介	Mock初始值	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初始值	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

/dto/host/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_uuids	Array	否	主机uuid
operate	String	否	操作名称 upgrade 升级 maintain 维护模式 renew_key：更新公钥
switch	Number		维护模式，0关，1开	0

Response

名称	类型	必选	简介	Mock初始值	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

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
data_source	String		年份	2021
ids	Array
	String

Response

名称	类型	必选	简介	Mock初始值	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

GET

Request

名称	类型	必选	简介	Mock初始值	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初始值	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、FAILED	SUCCESS
reason	String		失败原因	123