通用接口

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

新版本信息

获取新版本信息以及升级包下载地址

SDK方法名：latestVersion

URL

//check/latest_version

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
plat	String		example_plat	plat | String	平台 PC端Install.log中的平台信息，Android直接传mobile，iOS已经禁止app去检测更新

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
returnCode	Number		0
version	String		7.1.68.xxxx
downloadUrl	String		http://download.i2yun.com/upgrade/7.1.68.xxxx/example_plat-7.1.68.xxxx.zip	"{$server}/{$path}/{$rs['version']}/{$plat}-{$rs['version']}.zip"

获取版本提交记录

SDK方法名：listVersionHistory;

URL

//version_history

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。
version_history	Array	否			2
time	String	否	2020-03-03
version	String	否		版本号
content	Array	否		包含版本详细改动的数组

初始化（升级）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方法名：nodeConnectTest;

URL

//node/connect_test

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
ip	String
port	String
type	String		node	node - 节点； vp - vp平台
node_uuids	Array			node类型下发

Response

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

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

Dashboard-sysadmin

用户概要

SDK方法名：sysadmin;

URL

/dashboard/user_summary

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
users_num	Number		8
roles_num	Number		6
role_users	Array			可能存在新建的角色，不完全枚举	3
label	String		auditor	审计员
value	String		3
login_times	Object			最近一周的登录次数; 返回周几的顺序，会依据今天是周几做相应的变化
Mon	Number		33	Mon
Tues	Number		6	Tues
Wed	Number		7	Wed
Thurs	Number		11	Thur
Fri	Number		88	Fri
Sat	Number		23	Sat
Sun	Number		32	Sun

概览 - 总览

SDK方法名：statusOverall;

URL

//dashboard/status_overall

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Object
sys_uptime	Object
time_start	Number		0
time_now	Number		1611720608
db_node_status	Object
online	Number		0
warn	Number		0
excpt	Number		0
unknown	Number		0
node_status	Object
online	Number		0
maintain	Number		1
idle	Number		0
excpt	Number		2
unknown	Number		0
real_time_rule_status	Array				5
name	Array		["replication","maintain","mirror","stop","unknown"]		+1
sum	Number		0		+1
description	Object
rep	Number		0		+1
db_rule_status	Array				5
name	Array		["error","unknown","track","dump","stop"]		+1
sum	Number		0
description	Object
oracle	Number		0
mysql	Number		0
kafka	Number		0
gauss	Number		0
sqlserver	Number		0
postgres	Number		0
db2	Number		0
qianbase	Number		0
ha_rule_status	Array				5
name	Array		["run","maintain","switch","stop","unknown"]		+1
sum	Number		0
description	Object
ha	Number		0
copy_management_status	Array				6
name	Array		["wait","maintain","replication","finish","stop","unknown"]		+1
sum	Number		0
description	Object
compl_rep	Number		0
snapshot_task	Number		0
scheduled_rule_status	Array				6
name	Array		["replication","maintain","wait","finish","stop","unknown"]		+1
sum	Number		0		+1
description	Object
ffo	Number		0
vp	Number		0
backup	Number		0		+1
scheduled_rule_state	Object
success	Array		[0,0,0,0,0,0,0]
fail	Array		[0,0,0,0,0,0,0]
jump	Array		[0,0,0,0,0,0,0]
cancel	Array		[0,0,0,0,0,0,0]
time	Array		["01-27","01-26","01-25","01-24","01-23","01-22","01-21"]

概览 - 总览 日志

SDK方法名：listOverallLogs;

URL

//dashboard/overall_logs

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
get_all	Number		0	是否获取全部未读消息： 0：否； 1：是; （默认获取10条）

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
abnormal_logs	Array			异常日志	10
log_type	String		node	信息类型：节点 规则
name	String		@name	信息内容： 节点或规则名称
address	String		192.168.122.100	信息内容：节点IP
status	String		OFFLINE	该条信息的异常状态
time	Number		1605506910	异常状态发生的时间
uuid	String		BF202540-A60C-C25D-FA14-7F5AB400AE4D	用于操作， 点击该行，会跳转到对应的规则/节点 日志页面；同时用于标记已读该条信息。

概览 - 资源管理

SDK方法名：listOverallResourceSta;

URL

//dashboard/overall_resource

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Object
node	Object
total	Number		3
online	Number		0
maintain	Number		1
unknown	Number		0
offline	Number		2
windows	Number		1
linux	Number		2
db	Object
total	Number		0
online	Number		0
warn	Number		0
excpt	Number		0
unknown	Number		0
oracle	Number		0
mysql	Number		0
sqlserver	Number		0
kafka	Number		0
active_node	Object
total	Number		0
online	Number		0
maintain	Number		0
idle	Number		0
unknown	Number		0
windows	Number		0
linux	Number		0
offline	Number		0
vir_plat	Object
total	Number		0
online	Number		0
maintain	Number		0
unknown	Number		0
hyperv	Number		0
vmware	Number		0
drp	Number		0	容灾平台
cas	Number		0
cloud_plat	Object
total	Number		0
online	Number		0
maintain	Number		0
unknown	Number		0
huawei	Number		0
aws	Number		0
openstack	Number		0
hwcstack	Number		0
cluster	Object
total	Number		0
online	Number		0
maintain	Number		0
unknown	Number		0
mscluster	Number		0
dto_host	Object
total	Number		0
online	Number		0
maintain	Number		0	维护
unknown	Number		0
windows	Number		0
linux	Number		0
storage_pool	Object
offline	Number		1	离线
online	String		1	在线
total	Number		2
copy_volume	Object
mount_failed	Number		1	挂载失败
mounted	String		1	已挂载
online	Number			在线
offline	Number			离线
total	Number		2

概览 - 实时数据复制

SDK方法名：listOverallRealTimeCopy;

URL

//dashboard/overall_real_time_copy

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Object
rep	Array				5
name	String		@name
status	String		MIRROR
wk_node_name	String		68.211
bk_node_name	String		68.212
username	String		admin
band_width	String		012345600:00-23:592k
nas	Array				6
name	String		@name
status	String		ERROR
sync_name	String		67.111
wk_node_name	String		68.211
bk_node_name	String		68.212
username	String		admin
band_width	String
block	Array				7
name	String		@name
status	String		FINISH
wk_node_name	String		68.211
bk_node_name	String		68.212
username	String		admin
band_width	String

概览 - 应用高可用

SDK方法名：listOverallHa;

URL

//dashboard/overall_ha

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Array				10
name	String		@name	规则名称
rep_name	String		test111	复制规则名称
rep_uuid	String	是	@uuid	复制规则ID
rep_status	String		MIRROR	复制规则状态 正常状态：MIRROR REPLICATION RUN EXECUTING四种，其他未异常
master_name	String		192.168.28.255	主节点名称
slave_name	String		192.168.28.254	从节点名称
heartbeat	Number		1	心跳线

概览 - 副本管理

SDK方法名：listOverallCdm;

URL

//dashboard/overall_cdm

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Object
fsp	Object
takeover_drill	Object
run	Number		0	运行
shut_off	Number		0	关机
abnormal	Number		0	异常
ffo_mount	Object
connected	Number		4
mounted_sess	Number		3
create_failed	Number		2
unknown	Number		0
compl_rep	Array				6
name	Array		["finish","wait","replication","stop","failed","unknown"]		+1
sum	Number		0
storage	Object
copy_volume	Object
mounted	Number		0
online	Number		0
mount_failed	Number		0
mount_task	Object
mounted	Number		0
online	Number		0
mount_failed	Number		0
unmounted	Number		0
snapshot_task	Array				6
name	Array		["finish","wait","snap","stop","stale","unknown"]		+1
sum	Number		0

概览 - 系统迁移

SDK方法名：listOverallFspMv;

URL

//dashboard/overall_fsp_mv

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Array				5
wk_node_name	String		0.112
bk_node_name	String		12312qwdasdasd123
status	String		FFO_MOVING
progress	Number		90

概览 - 节点/复制规则 兼容6.1

SDK方法名：nodeRepSummary;

URL

//dashboard/node_rep_summary

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
summary	String			0：不返回复制规则的概要信息； 1：返回复制规则的概要信息； 默认值：1
cache	String			0：不返回节点的缓存信息； 1：返回节点的缓存信息； 默认值：0
rep_rule	String			0：不返回节点的复制规则信息； 1：返回节点的复制规则信息； 默认值：0
filter	String			0：不对节点和复制规则做过滤； 1：对节点和复制规则做过滤，如果节点开启 维护模式，返回的结果不包括该节点以及作 为工作机的规则； 默认值：1

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
returnCode	Number		0
returnMsg	String
time	Number		1617093240
date	String		2021-03-30 16:34:00
cache	Array
node_name	String		68.212
data_addr	String		172.20.68.212
mem_config	Number		1778384896
mem_used	Number		62914560
disk_config	Number		51036291072
disk_used	Number		0
status	String		ONLINE
summary	Object
REPLICATION	Number		2
MIRROR	Number		0
STOP	Number		0
STALE	Number		0
EXCPT	Number		0
UNKNOWN	Number		0
WAIT	Number		0
rep_total	Number		2
rep_rule	Array				2
rule_name	Array		["22","21"]		+1
src	String		68.212
target	String		68.212
status	String		REPLICATION
latency	Object
start_time	String		2021-03-30 16:33:57
interval	String		10
rep_uuid	Array		["7C8F8AF4-F171-A5E0-7BA5-F539C786A200","C9DBA051-9862-AE7F-2B4C-F8A38353B3BB"]		+1
latency	String		0
late_status	String		NODATA

概览 - 虚机概览，获取任务成功率

SDK方法名：listVpRuleStat;

URL

//dashboard/vp_rule

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
type	String		VP_PT	规则类型
wk_uuid	String		AC7A5A1F-5BB1-41D6-E075-1648ADC5C60B	源平台uuid
mode	String		month	模式month year

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
all_total_num	Number		49327	总数
all_success_num	Number		20429	总成功数
all_failed_num	Number		15173	总失败数
all_trans_data_num	String		208.68 TB	总传输量
all_trans_data_num_raw	Number		229441978639236
all_unread_err_num	Number		15173	总未读数
total_num	Number		0	当前平台总数
success_num	Number		0	当前平台成功数
failed_num	Number		0	当前平台失败数
trans_data_num	String		0 Bytes	当前平台传输量
trans_data_num_raw	Number		0
unread_err_num	Number		0	当前平台未读数
info_list	Array				30
success_num	Number		0
failed_num	Number		0
total_num	Number		0
trans_data_num	String		0 Bytes
unread_err_num	Number		0
time	Array		["09-19","09-20","09-21","09-22","09-23","09-24","09-25","09-26","09-27","09-28","09-29","09-30","10-01","10-02","10-03","10-04","10-05","10-06","10-07","10-08","10-09","10-10","10-11","10-12","10-13","10-14","10-15","10-16","10-17","10-18"]		+1
trans_data_num_raw	Number		0
all_vp_success_num	Number		19789	总虚机成功
all_vp_failed_num	Number		15016	总虚机失败
all_vp_other_num	Number		13116	总虚机其他数量
all_ffo_success_num	Number		640	总整机成功
all_ffo_failed_num	Number		157	总整机失败
all_ffo_other_num	Number		609	总整机其他数量

导出规则

SDK方法名：exportRules;

URL

//export_rules

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
suffix	String			csv, xlsx
type	String			复制规则：rep_backup； NAS：nas； 比较与同步：compare； 块复制：dtrack_backup； 块复制组：dtrack_group； 高可用：availability； 高可用组：ha_group； 全服备份/整机复制/整机迁移：fsp； 备份：timing_backup； 虚机备份：vp_backup； 虚机复制：vp_rep； 虚机迁移：vp_move； dto对象存储/比较与同步：dto_rule；
sub_type	String			普通复制规则：0； 集群复制规则：1； ASM复制规则：2； 全服备份：3； 整机复制：8； 整机迁移：1； dto对象存储：0； dto比较同步：2；
uuids	Array		[]	选中的规则uuid，默认为[]导出所有
where_args	Array
timing_type	String			普通定时备份：0； 集群定时备份：1；
raw_uuid	String			比较与同步主任务uuid

Response

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

展示列 - 新建|修改

SDK方法名：createColumnExt;

URL

//column_list

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
type	String			复制规则-普通：rep 复制规则-集群：cls_rep 复制规则-ASM：asm_rep 块复制：dtrack_backup 块复制组：dtrack_group 虚机备份：vp_backup 虚机迁移：vp_move 虚机复制：vp_rep 虚机恢复：vp_rc 虚机演练：vp_or
list_col	Object
name	Number		1	默认展示列：类型不同有所不同，具体字段参考展示列-单个接口的返回
wk_ip	Number		0
bk_ip	Number		0
cdp_switch	Number

Response

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

展示列 - 单个

SDK方法名：describeColumnext;

URL

//column_list

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
type	String			参考新建

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object			如果没有设置过则返回默认+可自定义列
code	Number		0
message	String
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
type	String		rep
list_col_default	Array			默认展示列，用户无法取消勾选
list_col_ext	Array			用户可设置列
list_col	Object
name	Number		1	默认展示列1
wk_ip	Number		0	自定义展示列根据是否勾选展示，默认0