通用接口

SDK类名：/common/GeneralInterface;

版本信息

获取控制台版本相关信息

SDK方法名：describeVersion

URL

/version

Method

GET

Request

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

Response

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

Response

名称	类型	必选	简介	Mock初始值	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		"{$server}/{$path}/{$rs['version']}/{$plat}-{$rs['version']}.zip"	http://download.i2yun.com/upgrade/7.1.68.xxxx/example_plat-7.1.68.xxxx.zip

获取版本提交记录

SDK方法名：listVersionHistory;

URL

/version_history

Method

GET

Request

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

Response

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

Response

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

连接测试

SDK方法名：nodeConnectTest;

URL

/node/connect_test

Method

POST

Request

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

Response

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

Response

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

Response

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

Response

名称	类型	必选	简介	Mock初始值	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		Mon	33
Tues	Number		Tues	6
Wed	Number		Wed	7
Thurs	Number		Thur	11
Fri	Number		Fri	88
Sat	Number		Sat	23
Sun	Number		Sun	32

概览 - 总览

SDK方法名：statusOverall;

URL

/dashboard/status_overall

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	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
storage_status	Object		存储池
online	Number		在线
excpt	Number		异常
unknown	Number		未知
warn	Number		警告
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				7
name	Array		原replication废弃，改为executing	["executing","replication","maintain","wait","finish","stop","unknown"]	+1
sum	Number			0	+1
description	Object
ffo	Number			0
vp_backup	Number			0
vp_move	Number			0
vp_rep	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"]
schedule_server_status	Object
nodes	Array		schedule server（集群则为多个）
running_time	String		运行时间 "[DD-]hh:mm:ss"，其中 "DD" 表示天数，"hh" 表示小时数，"mm" 表示分钟数，"ss" 表示秒数。 离线状态：返回空字符串
ip	String			1.1.1.1
status	String		状态，运行：NORMAL，停止：STOP，离线：OFFLINE	@pick("NORMAL","OFFLINE")
mem_used	String		内存字节数	123456789
pid	String		PID	123

概览 - 总览 日志

SDK方法名：listOverallLogs;

URL

/dashboard/overall_logs

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
get_all	Number		是否获取全部未读消息： 0：否； 1：是; （默认获取10条）	0
limit	Number		分页条数： 当get_all不为1时生效
days	String		1 - 近一天 7 - 近一周 30 - 近一月

Response

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

概览 - 资源管理

SDK方法名：listOverallResourceSta;

URL

/dashboard/overall_resource

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	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
fusion	Number			0
scp	Number			0
winstack	Number			0
aio	Number			0
cloud_plat	Object
total	Number			0
online	Number			0
maintain	Number			0
unknown	Number			0
huawei	Number			0
openstack	Number			0
hwcstack	Number			0
aws	Number			0
ecloud	Number			0
alicloud	Number
cloudos	Number
zstack	Number
hcso	Number
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	Number		在线	1
total	Number			2
storage_pool	Number		磁盘存储池	2
dto_storage	Number		对象存储池	3
copy_volume	Object
mount_failed	Number		挂载失败	1
mounted	Number		已挂载	1
online	Number		在线
offline	Number		离线
total	Number			2
dedupe_pool	Object
offline	Number		离线	1
online	Number		在线	1
total	Number			2

概览 - 实时数据复制

SDK方法名：listOverallRealTimeCopy;

URL

/dashboard/overall_real_time_copy

Method

GET

Request

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

Response

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

Response

名称	类型	必选	简介	Mock初始值	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	是	复制规则ID	@uuid
rep_status	String		复制规则状态 正常状态：MIRROR REPLICATION RUN EXECUTING四种，其他未异常	MIRROR
master_name	String		主节点名称	192.168.28.255
slave_name	String		从节点名称	192.168.28.254
heartbeat	Number		心跳线	1
node_info|2	Array		节点信息
node_name	String		节点名称
node_role	String		节点角色 HA_MASTER - 主节点 HA_SLAVE - 从节点

概览 - 副本管理

SDK方法名：listOverallCdm;

URL

/dashboard/overall_cdm

Method

GET

Request

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

Response

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

Response

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

Response

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

Response

名称	类型	必选	简介	Mock初始值	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_cancel_num	Number		总取消数	0
all_skip_num	Number		总跳过数	0
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
cancel_num	Number		当前平台取消数	0
skip_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
cancel_num	Number			0
skip_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
all_ffo_trans_data_num	String		总整机数据量
all_vp_trans_data_num	String		总虚机数据量
all_ffo_unread_err_num	String		总整机未读错误数
all_vp_unread_err_num	String		总虚机未读错误数

概览 - 周期性定时数据复制规则概览

SDK方法名：listSchedule;

URL

/dashboard/schedule_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number		页数
limit	Number		条数

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
message	String
code	Number			0
info_list	Array				2-10
name	String		规则名称	@first
uuid	String		规则uuid
wk_name	String		虚机/工作机/数据类型	@cname
type	String		规则类型（同biz_res_view视图）
subtype	String		规则具体类型（同biz_res_view视图）
user_uuid	String		用户uuid
create_time	String		创建时间
bkup_policy	Number		备份策略： 固定为1，表示周期性
bkup_schedule	Array				1-3
sched_every	Number		备份策略： 0：每天； 1：每周： 2：每月； 3：每隔	@integer(0, 3)
sched_day	Array		哪些天	['3','6']
sched_time	Array		哪些时间	['13:15', '25:61']
backup_type	String		备份类型： o：全备； i：增量； d：差异； m：合成； c：CBT；	@pick('o', 'i', 'd', 'm', 'c')
sched_gap_min	String		间隔时间
sched_time_start	String		开始时间
backup_type_show	String		（定时备份）
policys	String		（定时备份）
total	Number		总数

展示列 - 新建|修改

SDK方法名：createColumnExt;

URL

/column_list

Method

POST

Request

名称	类型	必选	简介	Mock初始值	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	Object		默认展示列：类型不同有所不同，具体字段参考展示列-单个接口的返回
display	Number			1
width	Number			80
wk_ip	Object
display	String			1
width	String			100
bk_ip	Object
display	String			1
cdp_switch	Object
display	String			1

Response

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

展示列 - 单个

SDK方法名：describeColumnext;

URL

/column_list

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	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		默认展示列，用户无法取消勾选
name	String			wk_ip
display	String			1
width	String			80
list_col_ext	Array		用户可设置列
name	String			bk_node_name
display	String			0
width	String		空字符串表示界面使用默认定义宽度	''
list_col	Object
bk_node_name	String		默认展示列1	1
wk_ip	String			0

导出规则

SDK方法名：exportRules;

URL

/export_rules

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
suffix	String		csv, xlsx
type	String		数据库同步模块： Oracle同步：oracle Mysql：mysql Sqlserver：sqlserver postgresql：postgres DB2：db2 DM：dm Kafka：kafka qianbase：qianbase oceanbase：oceanbase tidb：tidb informix：informix mongodb；mongo Oracle对象比较：oracle_obj_cmp Oracle对象修复：oracle_obj_fix Oracle表比较：oracle_tb_cmp 数据检查：datacheck 复制规则：rep_backup； 恢复恢复：rep_recovery; NAS：nas； 比较与同步：compare； 块复制：dtrack_backup； 块复制组：dtrack_group； 高可用：availability； 高可用组：ha_group； 整机备份、CDM复制、业务迁移：fsp； 整机恢复、CDM恢复：fsp_recovery; 定时备份：timing_backup； 定时还原：timing_recovery； 虚机备份：vp_backup； 虚机复制：vp_rep； 虚机迁移：vp_move； 虚机恢复：vp_recovery； dto对象存储/比较与同步：dto_rule； 大数据备份：bigdata_backup； 大数据还原：bigdata_recovery； 整机CDM - 接管、演练： cdm_rule； 定时任务：backup_work； // 以下为资源 节点：node； 备份集：backup_set;
sub_type	String		文件复制： 普通复制规则：0； 集群复制规则：1； ASM复制规则：2； 文件恢复： 即时恢复：0； cdp恢复：1； 快照恢复：2； 整机保护、CDM（备份）： 整机备份：3； CDM复制：8； 业务迁移：1； 整机保护、CDM（恢复）： 整机恢复：不传，默认为整机恢复； CDM恢复：9； dto对象存储：0； dto比较同步：2； // 以下为资源 b
uuids	Array		选中的规则uuid，默认为[]导出所有	[]
where_args	Array
timing_type	String		普通定时任务：0； 集群定时任务：1；
raw_uuid	String		比较与同步主任务uuid
for_import	Number		0：统计导出；（默认值） 1：全字段导出（为了导入的）	0
filter_uuid	String		9.x定时任务，过滤器uuid

Response

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

导入规则

SDK方法名：importRules;

URL

/import_rules

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	String		参考导出规则
file	String

Response

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

-----PKI-----

URL

Method

GET

Request

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

Response

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

签署CSR

用控制台CA证书签署 CSR并且生成一个证书返回

URL

/pki/csr_sign

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
_	String			f7d34d2ebc8e6
csr_file	String		PEM编码的CSR	-----BEGIN CERTIFICATE REQUEST----- MIID7jCCAlYCAQAwgagxCzAJBgNVBAYTAkNOMREwDwYDVQQIDAhTaGFuZ2hhaTEU MBIGA1UEBwwLR2xhc3RvbmJ1cnkxHjAcBgNVBAoMFUluZm9ybWF0aW9uMiBTb2Z0 d2FyZTEcMBoGA1UECwwTSTJzb2Z0IERldmVsb3AgVGVhbTEMMAoGA1UEAwwDZGV2 MSQwIgYJKoZIhvcNAQkBFhVzdXBwb3J0QGluZm8yc29mdC5jb20wggGiMA0GCSqG SIb3DQEBAQUAA4IBjwAwggGKAoIBgQDXfZ9/Kxgwyaa9OyYbxbFzn8D4C35PlvyA XwW7tRrYr9BVfO2k9ZmSb2rVIokhmC69ZSYtpeQkmX8hEdNDraDs+Ikvia5nj96K MfbVuepfOKEXhVGaLGaXZ/FAlIcobYTTk57KF7k51leSStqc3IC8V+hKfwaMH651 qFXIUZAC/+WZxZU43hedr2+HyDlatkLqluzWAeZLzAYzaad/7sW9MDP9sPQ8Gp1o J4ib4bDqIP1CtC6ud6A47zjKai1wVfMsZIL2m8AjW39LQQmEx34tDfiv5UKAPOt4 /Oy7x5XlFN5KJNSMnAN+z+Hd6F08jcIUxyMQ8F1rriVS+XlE5ZzM8a93sH80IH2U odMSkxwy3e6Jm1hgz60+K0Q3KZX3xeH48G7SqVa8iHVsmaqa0BpGEAII73ANDIVr JFAdQa44AX/080YeUdwZG82ArlCesrE90K7qXu1HEGc9XA2fixYWNbZIuVUxMl2Q +TEtYTMuREfU4wLvOWWzIcc/JrF5vwkCAwEAAaAAMA0GCSqGSIb3DQEBDAUAA4IB gQBPnbOV9BuAtEkmVOXO7tu/ZBFc6WbcRAesCb9N+M4Z+JoFwFZBsUTQdrpuIsPQ SJk6FDB4DyALQ0C0kbnUUczeSTYOc0/tpfarc1cTHU9CYit73UW6Ww/vT1eLB5H1 6vV3b3mRklIPE9dKLYG8lVOGuiKatjL41CI1TdUd+ZuYolCuxcJBBCamMdTCjl3m cnTDOgPZr9LdWgfYXUpLfZg12+4AyQ1tztPouX6Ux+TMGG7vpV+SzhQmywohwCiv V/V83RoKbR2IClnaRGnzUg77/KSrP7c1JBmRXNPusos1Yt9qecuoBE3Ky0t7px2k PTIS4vnLtICCpPHGtsxVHq9ylcu6uSz/ZPGgA0xmzXeilELLvoAzYW+S41qds3XV UyJ+NLO7M4scciU5zMemBdSbKNbbi4DfofMg15Lc6ljDz2llFhpMdDLOVmbzohkg SzxWfxCZU7I3oSHr9/WmHxZiDGdzgJKv0WnmIxv0CEfeauzj+tn4vzy/CnutQwY2 K+M= -----END CERTIFICATE REQUEST-----

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
crt_file	String		以 PEM 编码的格式导出字符串	-----BEGIN CERTIFICATE----- MIIE5DCCA0ygAwIBAgIBADANBgkqhkiG9w0BAQwFADCBpTELMAkGA1UEBhMCQ04x ETAPBgNVBAgMCFNoYW5naGFpMREwDwYDVQQHDAhTaGFuZ2hhaTEeMBwGA1UECgwV SW5mb3JtYXRpb24yIFNvZnR3YXJlMRwwGgYDVQQLDBNJMnNvZnQgRGV2ZWxvcCBU ZWFtMQwwCgYDVQQDDANkZXYxJDAiBgkqhkiG9w0BCQEWFXN1cHBvcnRAaW5mbzJz b2Z0LmNvbTAeFw0yMzA1MDkwOTE1NDFaFw0yNDA1MDgwOTE1NDFaMIGoMQswCQYD VQQGEwJDTjERMA8GA1UECAwIU2hhbmdoYWkxFDASBgNVBAcMC0dsYXN0b25idXJ5 MR4wHAYDVQQKDBVJbmZvcm1hdGlvbjIgU29mdHdhcmUxHDAaBgNVBAsME0kyc29m dCBEZXZlbG9wIFRlYW0xDDAKBgNVBAMMA2RldjEkMCIGCSqGSIb3DQEJARYVc3Vw cG9ydEBpbmZvMnNvZnQuY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKC AYEA132ffysYMMmmvTsmG8Wxc5/A+At+T5b8gF8Fu7Ua2K/QVXztpPWZkm9q1SKJ IZguvWUmLaXkJJl/IRHTQ62g7PiJL4muZ4/eijH21bnqXzihF4VRmixml2fxQJSH KG2E05Oeyhe5OdZXkkranNyAvFfoSn8GjB+udahVyFGQAv/lmcWVON4Xna9vh8g5 WrZC6pbs1gHmS8wGM2mnf+7FvTAz/bD0PBqdaCeIm+Gw6iD9QrQurnegOO84ymot cFXzLGSC9pvAI1t/S0EJhMd+LQ34r+VCgDzrePzsu8eV5RTeSiTUjJwDfs/h3ehd PI3CFMcjEPBda64lUvl5ROWczPGvd7B/NCB9lKHTEpMcMt3uiZtYYM+tPitENymV 98Xh+PBu0qlWvIh1bJmqmtAaRhACCO9wDQyFayRQHUGuOAF/9PNGHlHcGRvNgK5Q nrKxPdCu6l7tRxBnPVwNn4sWFjW2SLlVMTJdkPkxLWEzLkRH1OMC7zllsyHHPyax eb8JAgMBAAGjGjAYMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMA0GCSqGSIb3DQEB DAUAA4IBgQB0CTyT9NCZhs/wiH6KBKIORC1InB47aqSGKXcgBrjNWYwBGA0Y+MFP H/sNM/DTas3oXuVio9cVRaSMuzlzOIRX3Zz88UZh7XLEokh+c1acS0++CFLtMVo8 qVaJVQmm3W6ObP/LC4fohAxfvTEMVZXI3X4wfGvn+xF6EOHOs+Zqks28F4m2ZL3N R4bL2MuNBuF391Sv+AuRWLy+9d95gt0v27/4O72l6eBwkX9w763KBTu2D3+nZclP 3Z71+mofA91Y/7MTyTW8OJ3xJZf1/0hSrhXG0wljd7apiBX8xXwSnzwLoU9d9kG4 JoylruQW9t3XFbBLChZwkq9UskpxniJy0j/lian1KjjCmln5vZYwWTwtgJwkX5Gs 8jkzkevNcMIr5CA51MkEhgcJ3Mps2hQRd3fDQAzlJ8f8PnesItF5mgxeKKsVQQDI ffu9XBF02c2uoegQJ7moqQpubKhWIenuVd3P+BFWDM2xVLsbIwokFNM3LSPSXpyS JQwyG1U/pQA= -----END CERTIFICATE-----

证书清单

控制台所有证书清单

URL

/pki/certs

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Array				3
cert_name	Array			["ca.crt","console.up.com.crt","db.crt"]	+1
base_name	Array			["ca","up-apiserver","db-pg"]	+1
not_after	Number			1720592717	+1
expire_date	Array			["2024-07-10T06:25:17+00:00","2024-07-05T06:25:18+00:00","2024-07-05T06:25:19+00:00"]	+1
status	String		VALID 有效 INVALID 无效	VALID

下载根证书

i2up ca.crt 下载

URL

/pki/download_ca

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
ca	String			-----BEGIN CERTIFICATE----- MIIET*********jnHO0= -----END CERTIFICATE-----

总览 - 板块信息 - 获取

SDK方法名：getDashboardPlate;

URL

/dashboard/plate

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
dashbord_plate	Array				6
name	Array		backup_rule_stat-备份规则状态 rep_stat-复制规则状态 statistics_stat-事件记录 node_stat-主机节点 vir_plat_stat-虚拟平台 bigdata_plat_stat-大数据 storage_pool_stat-存储池 storage_unit_stat-存储单元 ha_stat-高可用规则 overall_logs-消息列表	["backup_rule_stat", "rep_stat", "statistics_stat", "node_stat", "vir_plat_stat", "bigdata_plat_stat", "storage_pool_stat", "storage_unit_stat", "ha_stat", "overall_logs"]	+1
display	Number

总览 - 板块信息 - 更新

SDK方法名：updateDashboardPlate;

URL

/dashboard/plate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
plate_info	Array
name	String		backup_rule_stat-备份规则状态 rep_stat-复制规则状态 statistics_stat-事件记录 node_stat-主机节点 vir_plat_stat-虚拟平台 bigdata_plat_stat-大数据 storage_pool_stat-存储池 storage_unit_stat-存储单元 ha_stat-高可用规则 overall_logs-消息列表
display	Number		0 - 不显示 1 - 显示	1

Response

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

概览 - 总览 - 新接口

SDK方法名：getDashboardStatOverall;

URL

/dashboard/stat_overall

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
statistics_days	Number		事件记录事件范围 1-近一天 7-近一周 30-近一月

Response

名称	类型	必选	简介	Mock初始值	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
backup_rule_stat	Object		备份规则状态统计
enable	Number		规则启用数	0
disable	Number		规则禁用数	0
rep_stat	Object		复制规则状态统计
mirror	Number		镜像
replication	Number		复制
stop	Number		停止
unknown	Number		未知
except	Number		异常
stale	Number		失效
statistics_stat	Object		事件记录
success	Number		成功任务数	0
failed	Number		失败任务数	0
node_stat	Object		主机节点
online	Number		在线
offline	Number		离线
vir_plat_stat	Object		虚拟平台
online	Number		在线
offline	Number		离线
bigdata_plat_stat	Object		大数据
online	String		在线
offline	String		离线
storage_pool_stat	Object		存储池
pool_num	Number		存储池数量
total	Number		存储容量
used	Number		已用容量
free	Number		可用容量
storage_unit_stat	Object		存储单元
normal	Number		在线
offline	Number		离线
excpt	Number		异常，包括: error:错误 space_full：空间满 space_warnning：空间告警 pool_degraged：存储池错误 pool_faulted：存储池错误 pool_offline：存储池离线 pool_unavail：存储池不可用 pool_removed：存储池移除
ha_stat	Object		高可用规则
run	Number		运行
warn	Number		警告
stop	Number		停止
unknown	Number		未知
switch	Number		切换