通用接口

SDK类名：/common/GeneralInterface

版本信息

获取控制台版本相关信息

SDK方法名：describeVersion

URL

/version

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
prod_type	String	否	STD
version	String	否	7.0.0.80
api_version	String	否	2.0.0
bundle_version	String	否	2e44b27
build_date	String	否	20181018
migration_version	Number	否	201803130622295

初始化（升级）DB-migrate

SDK方法名：updateDatabase

URL

/migrate

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200	@mock=200
data	Object	否
code	Number	否	0	@mock=0
message	String	否	success update to latest version	@mock=success update to latest version
msg	String	否

统计报表 - 获取列表

SDK方法名：listStatistics

URL

/statistics

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
page	Number	否	1	默认为1, 符合条件范围的当前页数
name	String	否		搜索过滤字段, 名称
limit	Number	否	10	默认为系统参数设置数量, 每页数量
start	Number	否		时间戳，非必填, 查询开始时间
end	Number	否		时间戳，非必填, 查询结束时间
status	String	否		可选，用是否已读过滤，0：未读；1：已读；
type	String	否		可选，总的未读数量框子点进去就传数组，用任务类型过滤，

'I2BAK_BK'：定时备份， 'I2BAK_RC'：定时备份-还原， 'I2VP_BK'： 备份规则， 'I2VP_RC'：恢复规则， 'I2VP_MV'：迁移规则， 'I2VP_PT'：复制规则， 'I2VP_OR'：虚机演练规则， 'I2FFO_BK'：全服备份， ‘I2VP’：虚机相关所有记录 | src_type | Number | 否 | | 备份类型： 源类型，VP不传； 没有该参数表示全部；

0-文件； 1-raw(暂不支持)； 2-块设备； 3-mssql； 4-oracle； 5-cloud_blk (暂不支持)； 6-db2(暂不支持)； 7-vmdk(暂不支持)； 8-qcow2(暂不支持)； | uuid | String | 否 | | 可选，用任务uuid过滤 | group_uuid | String | 否 | | 可选，用任务组uuid过滤，比如 vp nas 等有 group_uuid 的模块 | wk_uuid | String | 否 | | 工作机uuid、源平台uuid，查看平台未读错误数时用此字段过滤 | bk_uuid | String | 否 | | 备机uuid | other_uuid | String | 否 | | 同步机uuid、目标平台uuid | result | Number | 否 | | 可选，用任务结果过滤，0：成功；1：备份取消；2：跳过；3：备份失败 | statistics_start | Number | 否 | | 报表生成时间 | statistics_end | Number | 否 | | 报表生成时间 | time_used_rate | Number | 否 | | 执行时间过滤 0:不到50% 1:超过50% 2:超过100% | obj_name | String | 否 | | 可选，根据节点或虚机名称获取统计时才传 | time_consuming | Number | 否 | | 0关1开，传1，返回当前条件查询出来的任务的总耗时时间 time_consuming |

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否
list	Array	否			5
id	String	否	6
name	String	否	1	名称
uuid	String	否	4E2609C0-71DA-F693-43A4-EB92C4C42C95	相关规则任务的UUID
detail	String	否	{"bkup_window":"00:00-00:00","create_time":"2019-12-11 20:04:11","data_writed_num":"762","dir_failed_num":"--","dup_rate":"00.00%","end_time":"2019-12-11 20:04:11","file_skiped_num":0,"name":"1","policy":3,"project_failed_num":"","result":0,"space_occu":"12288","src_size":"0","src_type":0,"stage":0,"start_time":"2019-12-11 20:04:10","sync_obj_num":0,"time_used_rate":"","tran_rate":"802.00","trans_data_num":"802","type":"I2BAK_BK","used_time":"1","uuid":"4E2609C0-71DA-F693-43A4-EB92C4C42C95"}
result	String	否	0	运行结果
start_time	String	否	2019-12-11 20:04:10	开始时间
end_time	String	否	2019-12-11 20:04:11	结束时间
type	String	否	I2BAK_BK
status	String	否	0
create_time	String	否	1576066341
time_used_rate	String	否	0
user_uuid	String	否	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
wk_uuid	String	否
bk_uuid	String	否
other_uuid	String	否
time_consuming	Number	否		单位秒，返回当前条件查询出来的任务的总耗时时间，只有入参有 time_consuming=1，才会返回这个字段
total	Number	否	5

统计报表 - 统计详情

id 报表list返回的id，并不是uuid

SDK方法名：describeStatistics

URL

//statistics/:id([0-9]+)

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
msg	String	否		@mock=
data	Object	否
detail	Object	否
result	String	否	SUCCEED	@mock=SUCCEED, 运行结果
dup_rate	String	否	00.00%	@mock=00.00%, 去重百分比
policy	Number	否	3	@mock=3, 1 一次性任务 2 周期性任务 3 立即执行
bkup_window	String	否	00:00-00:00	@mock=00:00-00:00, 备份窗口
src_size	String	否	110.00bytes	@mock=110.00bytes, 源数据大小
src_type	Number	否	0	@mock=0, 0: 文件 ，1：快照 ， 2：块设备 ，其他值 ：SqlServer
type	String	否	I2BAK_BK	@mock=I2BAK_BK, I2BAK_BK: 备份 ， I2BAK_RC: 还原
start_time	String	否	2018-06-05 18:09:27	@mock=2018-06-05 18:09:27
sync_obj_num	Number	否	5	@mock=5, 同步对象数
uuid	String	否	546EA90D-B4BC-5523-3840-1F24C69BEA78	@mock=546EA90D-B4BC-5523-3840-1F24C69BEA78
dir_failed_num	String	否	Not_Valid	@mock=Not_Valid, 失败文件夹
project_failed_num	String	否	Not_Valid	@mock=Not_Valid, 失败项目
trans_data_num	String	否	4.04KB	@mock=4.04KB, 传输数据大小
create_time	String	否	2018-06-05 18:09:28	@mock=2018-06-05 18:09:28
file_skiped_num	Number	否	0	@mock=0, 跳过文件
name	String	否	YXNkZmFzZGY=	@mock=YXNkZmFzZGY=
end_time	String	否	2018-06-05 18:09:28	@mock=2018-06-05 18:09:28
data_writed_num	String	否	3.88KB	@mock=3.88KB, 写入数据
space_occu	String	否	20.00KB	@mock=20.00KB, 占用空间
stage	Number	否	0	@mock=0, 0 完成 1 停止 8 等待
code	Number	否	0	@mock=0
message	String	否		@mock=
ret	Number	否	200	@mock=200

统计报表 - 标为已读

从Dashboard未读错误数点进来需要调用这个接口清掉那个数

SDK方法名：readStatistics

URL

//statistics

Method

PUT

Request

名称	类型	必选	初始值	简介	Mock规则
page	Number	否	1	以下参数同获取统计报表入参
end	Number	否	1
name	String	否
limit	Number	否	10
start	Number	否	1
status	String	否
type	String	否
result	Number	否	1
group_uuid	String	否
uuid	String	否
statistics_start	Number	否	1
statistics_end	Number	否	1
time_used_rate	Number	否	1
src_type	Number	否	1
obj_name	String	否
time_consuming	Number	否	1
wk_uuid	String	否
bk_uuid	String	否
other_uuid	String	否

Response

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

统计报表 - 整体统计

SDK方法名：listStatisticsChart; 获取结果统计和性能统计

URL

//statistics/chart

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
start	Number	否	1	可选表自动周期 开始时间
end	Number	否	2	可选表自动周期 结束时间
src_type	String	否	0	备份类型：

源类型，VP不用传这个； 没有该参数表示全部 0-文件； 1-raw(暂不支持)； 2-块设备； 3-mssql； 4-oracle； 5-cloud_blk (暂不支持)； 6-db2(暂不支持)； 7-vmdk(暂不支持)； 8-qcow2(暂不支持)； | type | String | 否 | I2BAK_BK | 虚机规则：I2VP_BK,I2VP_RC,I2VP_PT,I2VP_MV,I2VP_OR； 其他： I2BAK_BK, I2FFO_BK， 默认I2BAK_BK, 概览：OVERVIEW | page | Number | 否 | 1 | | limit | Number | 否 | 10 | |

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
statistics_info	Object	否
result_statistics	Object	否
success	Number	否	1
failed	Number	否	1
skipped	Number	否	1
performance_statistics	Object	否		先注释掉，性能饼图暂时隐藏
timeout	Number	否	3
over_half_time_spent	Number	否	4
less_half_time_spent	Number	否	5
overview_list	Object	否
file	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
blk	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
mssql	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
oracle	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
db2	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
ffo	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
vp_backup	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
vp_move	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
vp_rep	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
vp_rc	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
vp_drill	Object	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
task_list	Array	否			2
obj_name	String	否
node_addr	String	否
success	Number	否
failed	Number	否
skipped	Number	否
canceled	Number	否
data_total_writed	Number	否
uuid	String	否		任务的uuid，每条统计信息里面有一个uuid，这个uuid是对应任务的uuid，当点击节点失败/成功/跳过/取消/数，会传这个uuid去匹配对应的统计信息
task_list_total	Number	否		task_list总数

统计报表 - 发送配置

URL

//statistics/config

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
daily_report	Object	否
daily_sw	Boolean	否	0
daily_st	String	否	00:00
all_sw	Boolean	否	0
file_sw	Boolean	否	0
blk_sw	Boolean	否	0
mssql_sw	Boolean	否	0
oracle_sw	Boolean	否	0
db2_sw	Boolean	否	0
ffo_sw	Boolean	否	0
vp_backup_sw	Boolean	否	0
vp_move_sw	Boolean	否	0
vp_rep_sw	Boolean	否	0
vp_rc_sw	Boolean	否	0
vp_drill_sw	Boolean	否	0
weekly_report	Object	否
weekly_sw	Boolean	否	0
weekly_st	String	否	1,00:00
all_sw	Boolean	否	0
file_sw	Boolean	否	0
blk_sw	Boolean	否	0
mssql_sw	Boolean	否	0
oracle_sw	Boolean	否	0
db2_sw	Boolean	否	0
ffo_sw	Boolean	否	0
vp_backup_sw	Boolean	否	0
vp_move_sw	Boolean	否	0
vp_rep_sw	Boolean	否	0
vp_rc_sw	Boolean	否	0
vp_drill_sw	Boolean	否	0
monthly_report	Object	否
monthly_sw	Boolean	否	0
monthly_st	String	否	1,00:00
all_sw	Boolean	否	0
file_sw	Boolean	否	0
blk_sw	Boolean	否	0
mssql_sw	Boolean	否	0
oracle_sw	Boolean	否	0
db2_sw	Boolean	否	0
ffo_sw	Boolean	否	0
vp_backup_sw	Boolean	否	0
vp_move_sw	Boolean	否	0
vp_rep_sw	Boolean	否	0
vp_rc_sw	Boolean	否	0
vp_drill_sw	Boolean	否	0
email	String	否

Response

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

统计报表 - 获取配置信息

获取当前用户统计报表配置信息

URL

//statistics/config

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
statistics_report_conf	Object	否
daily_report	Object	否
daily_sw	Boolean	否	0
daily_st	String	否	00:00
all_sw	Boolean	否	0
file_sw	Boolean	否	0
blk_sw	Boolean	否	0
mssql_sw	Boolean	否	0
oracle_sw	Boolean	否	0
db2_sw	Boolean	否	0
ffo_sw	Boolean	否	0
vp_backup_sw	Boolean	否	0
vp_move_sw	Boolean	否	0
vp_rep_sw	Boolean	否	0
vp_rc_sw	Boolean	否	0
vp_drill_sw	Boolean	否
weekly_report	Object	否
weekly_sw	Boolean	否	0
weekly_st	String	否	1,00:00
all_sw	Boolean	否	0
file_sw	Boolean	否	0
blk_sw	Boolean	否	0
mssql_sw	Boolean	否	0
oracle_sw	Boolean	否	0
db2_sw	Boolean	否	0
ffo_sw	Boolean	否	0
vp_backup_sw	Boolean	否	0
vp_move_sw	Boolean	否	0
vp_rep_sw	Boolean	否	0
vp_rc_sw	Boolean	否	0
vp_drill_sw	Boolean	否
monthly_report	Object	否
monthly_sw	Boolean	否	0
monthly_st	String	否	1,00:00
all_sw	Boolean	否	0
file_sw	Boolean	否	0
blk_sw	Boolean	否	0
mssql_sw	Boolean	否	0
oracle_sw	Boolean	否	0
db2_sw	Boolean	否	0
ffo_sw	Boolean	否	0
vp_backup_sw	Boolean	否	0
vp_move_sw	Boolean	否	0
vp_rep_sw	Boolean	否	0
vp_rc_sw	Boolean	否	0
vp_drill_sw	Boolean	否
email	String	否	wenc@info2soft.com

统计报表 - 下载

URL

//statistics/download

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
page	Number	否	1	默认为1, 符合条件范围的当前页数
name	String	否		搜索过滤字段, 名称
limit	Number	否	10	默认为系统参数设置数量, 每页数量
start	Number	否		时间戳，非必填, 查询开始时间
end	Number	否		时间戳，非必填, 查询结束时间
status	String	否		可选，用是否已读过滤，0：未读；1：已读；
type	String	否		可选，总的未读数量框子点进去就传数组，用任务类型过滤，

'I2BAK_BK'：定时备份， 'I2BAK_RC'：定时备份-还原， 'I2VP_BK'： 备份规则， 'I2VP_RC'：恢复规则， 'I2VP_MV'：迁移规则， 'I2VP_PT'：复制规则， 'I2VP_OR'：虚机演练规则， 'I2FFO_BK'：全服备份， ‘I2VP’：虚机相关所有记录 | src_type | Number | 否 | | 源类型，VP不用传这个 | uuid | String | 否 | | 可选，用任务uuid过滤 | group_uuid | String | 否 | | 可选，用任务组uuid过滤，比如 vp nas 等有 group_uuid 的模块 | wk_uuid | String | 否 | | 工作机uuid、源平台uuid，查看平台未读错误数时用此字段过滤 | bk_uuid | String | 否 | | 备机uuid | other_uuid | String | 否 | | 同步机uuid、目标平台uuid | result | Number | 否 | | 可选，用任务结果过滤，0：成功；1：备份取消；2：跳过；3：备份失败 | statistics_start | Number | 否 | | 报表生成时间 | statistics_end | Number | 否 | | 报表生成时间 | time_used_rate | Number | 否 | | 执行时间过滤 0:不到50% 1:超过50% 2:超过100% | obj_name | String | 否 | | 可选，根据节点或虚机名称获取统计时才传 | time_consuming | Number | 否 | | 0关1开，传1，返回当前条件查询出来的任务的总耗时时间 time_consuming |

Response

名称	类型	必选	初始值	简介	Mock规则
msg	String	否
ret	Number	否	200
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功
download_url	String	否	E:\ctrlcenter\wwwroot\default\public\download\xxx.zip
file_name	String	否	xxx.zip

Dashboard-整体状态统计

SDK类名：/dashboard/Dashboard;

SDK方法名：overall

首页Dashboard 整体状态统计图表

URL

/dashboard/overall

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
node_num	Number	否	13
rep_num	Number	否	20
ha_num	Number	否	30
node	Object	否
ONLINE	Number	否	4
OFFLINE	Number	否	6
UNKNOWN	String	否	3	数据库中为空（未曾送过状态到控制机）
rep	Object	否
UNKNOWN	Number	否	2
STOP	Number	否	3
REPLICATION	Number	否	5
MIRROR	Number	否	6
EXCEPTION	Number	否	1
STALE	Number	否	3
SWITCH	Number	否	3
ha	Object	否
master_role	Object	否
HA_UNKNOWN	Number	否	2
HA_UNJOIN	Number	否	2
HA_MASTER	Number	否	2
HA_SLAVE	Number	否	3
HA_SWITCH	Number	否	2
master_status	Object	否
HA_UNKNOWN	Number	否	2
HA_STOP	Number	否	3
HA_START	Number	否	3
HA_RUN	Number	否	3
HA_MIRROR	Number	否	3
HA_READY	Number	否	3
HA_WARN	Number	否	4
HA_FAIL	Number	否	4

Dashboard-平台监控（整体状态+VP）

SDK方法名：upMonitorOverall

URL

/dashboard/up_monitor_overall

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。
overall	Object	否
code	Number	否	0
message	String	否	[0] success
node_num	Number	否	21
rep_num	Number	否	12
ha_num	Number	否	2
node	Object	否
UNKNOWN	Number	否	17
OFFLINE	Number	否	0
ONLINE	Number	否	4
rep	Object	否
UNKNOWN	Number	否	4
FINISH	Number	否	0
STOP	Number	否	3
REPLICATION	Number	否	4
MIRROR	Number	否	0
EXCEPTION	Number	否	0
STALE	Number	否	1
SWITCH	Number	否	0
WAIT	Number	否	0
EXECUTING	Number	否	0
IDLE	Number	否	0
DEAD	Number	否	0
ha	Object	否
master_status	Object	否
HA_UNKNOWN	Number	否	0
HA_STOP	Number	否	0
HA_START	Number	否	0
HA_RUN	Number	否	2
HA_MIRROR	Number	否	0
HA_READY	Number	否	0
HA_WARN	Number	否	0
HA_FAIL	Number	否	0
master_role	Object	否
HA_UNKNOWN	Number	否	0
HA_UNJOIN	Number	否	0
HA_MASTER	Number	否	2
HA_SLAVE	Number	否	0
HA_PREOVER	Number	否	0
HA_POSTOVER	Number	否	0
HA_PREBACK	Number	否	0
HA_POSTBACK	Number	否	0
HA_SWITCH	Number	否	0
vp_vm	Object	否
code	Number	否	0
message	String	否	[0] success
vm_protected	Number	否	0
vm_total	Number	否	0
vp_rule	Object	否
code	Number	否	0
message	String	否	[0] success
all_total_num	Number	否	167
all_trans_data_num	String	否	45.31 GB
all_success_num	Number	否	32
all_unread_err_num	Number	否	135
total_num	Number	否	94
trans_data_num	String	否	35.76 GB
success_num	Number	否	25
unread_err_num	Number	否	69
up	Object	否
ONLINE	Number	否	1
OFFLINE	Number	否	0