整机CDM

SDK类名：/cdm/Cdm;

自动演练规则 - 新建

SDK方法名：createCdmDrill

URL

/cdm_drill

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vm_name	String			测试5
vm_ref	String			vm-10811
limit	Number		数据保留期限（天）	3
sched_day	Array		备份策略 - 周期任务 - 哪几天，num数组； 【每月】、【每周】专用参数；取值：每月：1-31；每周：0-6（周日-周六）	[1, 2, 3]
sched_time	Array		备份策略 - 周期任务 - 运行时间；str数组；取值格式HH:mm	["00:00"]
sched_every	Number		备份策略 - 周期任务 - 策略类型；0：每天；1：每周：2：每月；	0
bkup_type	Number		备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异	0
rule_name	String		规则名称（备份规则任务和复制规则任务的名称）
rule_type	Number		对应规则类型：备份：0；复制：1；整机备份：2 ；整机复制：3	0
vp_uuid	String		演练平台对应 虚拟平台的ID
auto	Number		自动演练：自动：1，手动：0；	0
vm_list	Array
vm_name	String		虚机(工作机)名称
new_vm_name	String		新虚机名称
scripts	String		演练脚本
bk_uuid	String		源规则 bk_uuid
bk_path	String		源规则 bk_path
time	String		选择的时间点，RPC不用
original_rule_uuid	String		原始规则uuid
scripts_type	Number		(*必填)脚本验证的方式，0表示验证ping方法验证，1表示tcp端口验证测试，2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0
os_type	Number		（新加）虚拟机操作系统： 0：linux； 1：windows
os_ip	String		虚拟机ip
wk_uuid	String		工作机uuid (整机备份类型，必传)
src_uuid	String		源规则的源平台uuid，获取导入的虚机信息时需要用到
data_ip_uuid	String		灾备机数据地址
ver_sig	String		备份点id
backup_type	String			i
del_bkup_data	Number			0
automate	Number		隐藏开关，默认传0，页面不显示	0
auto_shutdown	Number			1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
message	String		, 错误信息提示
code	Number		@mock=0	0
fail_list	Array
name	String		可能存在名称，此模块没有
uuid	String		可能存在uuid，此模块有
vm_name	String		vp 模块专有
success_list	Array		内容类似 fail_list
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功
rule_uuid	String
vm_name	String
new_vm_name	String

自动演练规则 - 获取单个

查看规则，URL参数为 group_uuid

SDK方法名：describeCdmDrill

URL

/cdm_drill/group/:uuid([a-f0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
message	String
code	Number			0
info_list	Array
vp_backup	Object
del_bkup_data	Number			1
quiet_snap	Number			1
quick_back	Number			1
vp_uuid	String			1663DD96-C9BE-B49E-6044-3AB3120F4B74
bk_path	String			C:\test\
bk_uuid	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
lan_free	Number			1
rule_name	String			temp
bkup_policy	Number			0
bkup_one_time	Number			1515568566
bkup_schedule	Array
limit	Number			3
sched_day	Array			[1,2,3]
sched_time	Array			["00:00"]
sched_every	Number			0
bkup_type	Number			0
create_time	String			1515568566
rule_uuid	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
random_str	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
username	String			Joseph Johnson
user_uuid	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
total	Number			1
vp_name	String		平台名称	vp_name
bk_node_name	String		备机名
group_uuid	String			@guid
vm_list	Array
vm_name	String			@name
vm_ref	String			110
band_width	String			-1
vp_type	Number
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功
vp_drill_rule	Object
username	String			admin
rule_name	String
rule_type	Number			0
vp_uuid	String
bk_uuid	String
bk_path	String
datacenter	String
hostname	String
datastore	String
auto	Number			0
scripts	String
vm_list	Array
vm_name	String
new_vm_name	String
vm_ref	String			99
mac	String
cpu	Number			1
ver_sig	String
core_per_sock	Number			1
mem_mb	Number			1024
overwrite	Number			0
quick_back	Number			1
backup_type	String			i
lan_free	Number			23
del_bkup_swap	Number			0
automate	Number			0
auto_shutdown	Number			1
bkup_policy	Number			0
bkup_schedule	Object
sched_time_start	String			0
sched_day	Number			6
sched_every	Number			0
limit	Number			0
sched_gap_min	Number			0
sched_time	Array
bk_node_name	String			88.107
biz_grp_list	Array
create_time	String			1533871285
group_uuid	String
data_ip_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
del_bkup_data	Number			0
vp_name	String			88.107
vp_type	Number			0
random_str	String			AB790B28-62D6-7236-612F-65D73C80036F

自动演练规则 - 获取组

查看规则，URL参数为 group_uuid

SDK方法名：describeCdmDrillGroup

URL

/cdm_drill/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
message	String
code	Number			0
vp_backup	Object
del_bkup_data	Number			1
quiet_snap	Number			1
quick_back	Number			1
vp_uuid	String			1663DD96-C9BE-B49E-6044-3AB3120F4B74
bk_path	String			C:\test\
bk_uuid	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
lan_free	Number			1
rule_name	String			temp
bkup_policy	Number			0
bkup_one_time	Number			1515568566
bkup_schedule	Array
limit	Number			3
sched_day	Array			[1,2,3]
sched_time	Array			["00:00"]
sched_every	Number			0
bkup_type	Number			0
create_time	String			1515568566
rule_uuid	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
random_str	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
username	String			Joseph Johnson
user_uuid	String			C02B76DB-EBE8-E029-B645-072B2E1A7460
total	Number			1
vp_name	String		平台名称	vp_name
bk_node_name	String		备机名
group_uuid	String			@guid
vm_list	Array
vm_name	String			@name
vm_ref	String			110
band_width	String			-1
vp_type	Number
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功
vp_drill_rule	Object
rule_name	String
rule_type	Number			0
vp_uuid	String
bk_uuid	String
bk_path	String
datacenter	String
hostname	String
datastore	String
auto	Number			0
scripts	String
vm_list	Array
vm_name	String
new_vm_name	String
vm_ref	String			99
mac	String
cpu	Number			1
ver_sig	String
core_per_sock	Number			1
mem_mb	Number			1024
overwrite	Number			0
quick_back	Number			1
backup_type	String			i
lan_free	Number			23
del_bkup_data	Number			0
del_bkup_swap	Number			0
automate	Number			0
auto_shutdown	Number			1
bkup_policy	Number			0
bkup_schedule	Object
sched_time_start	String			0
limit	Number			0
sched_day	Number			6
sched_every	Number			0
sched_time	Array
sched_gap_min	Number			0
rule_uuid	String
group_uuid	String
vp_name	String			88.107
vp_type	Number			0
bk_node_name	String			88.107
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String			admin
create_time	String			1533871285
random_str	String			AB790B28-62D6-7236-612F-65D73C80036F
biz_grp_list	Array
data_ip_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC

自动演练规则 - 删除

删除规则

SDK方法名：deleteCdmDrill

URL

/cdm_drill

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array			["11111111-1111-1111-1111-111111111111"]
group_uuids	Array		组操作，有这个就先用这个，没有就用规则uuid
delete_tgtvm	Number		是否删除演练虚机，0，1	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
code	Number		@mock=0	0
message	String		, 错误信息提示
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功

自动演练规则 - 状态

获取规则的状态

SDK方法名：listCdmDrillStatus

URL

/cdm_drill/status

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
count	String		@mock=1	1
message	String		, 错误信息提示
code	Number		@mock=0	0
status	String		stop,executing,idle,dead,finish,switch,unknown,	@pick(["STOP","EXECUTING","IDLE","DEAD","FINISH","SWITCH","UNKNOWN","VP_START","VP_CHECK","VP_CFG","VP_CBT"])
progress	Number				0-100
rule_uuid	String		@mock=@guid()	@guid
msg	String
data	Object
count	String			1
message	String
code	Number			0
status	Array				2
status	String		SUCCESS FAILED	VP_START
progress	Number			71
rule_uuid	String			Ac2F4EFC-14FE-b2Ab-7988-7AD4f44979E3
ret	Number			200

自动演练规则 - 操作

SDK方法名：

停止：stopCdmDrill

开始：startCdmDrill

设置状态： setStatusCdmDrill

URL

/cdm_drill/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String		"start", "stop", "set_status"：启动、停止、设置状态（仅运行状态可以）
rule_uuids	Array		规则uuid列表	[C6335F62-2565-1957-4BB9-587F2FF46B00]
group_uuids	Array		组操作，有这个就先用这个，没有就用规则uuid
status	String		仅设置状态传：状态码，0成功，-1失败
msg	String		仅设置状态传：用户上传的信息

Response

名称	类型	必选	简介	Mock初始值	Mock规则
message	String		, 错误信息提示
code	Number		@mock=0	0
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功

自动演练规则 - 获取虚机状态

获取规则的状态

SDK方法名：queryGroupVmStatus

URL

/cdm_drill/vm_status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String		规则uuid，此值为空时group_uuid必选
group_uuid	String		规则的组uuid，此值为空时rule_uuid必选

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Array
code	String
message	String
list	Array
rule_uuid	String
rule_name	String		规则名称
name	String		规则创建的目标虚拟机名称
vm_status	String		状态可能是： CREATING: 正在创建 (禁止其它操作) RESTORING: 正在回切 (禁止其它操作) IMAGE_LOCKED : 虚机关机，且虚机不能开，因为磁盘正在被操作 (禁止其它操作) CREATE_FAILED: 创建失败 （只允许删除操作） DOWN: 关机 （允许 删除 和开机 操作） POWERING_DOWN：正在关机 (允许打开控制台, 禁止其它操作) POWERING_UP: 正在开机 (允许 关机 和 打开控制台 操作) WAIT_FOR_LAUNCH：将要开机 (禁止其它操作) UP： 虚机正在运行 （允许 关机 和 打开控制台 操作） NON_EXIST： 虚机不存在 （只允许删除操作） UNKNOWN : 未知 (可以删除，删除时弹出2次确认对话框，禁止其它操作)

----- 整机复制 -----

URL

 /dash/cdm

Method

GET

Request

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

Response

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

整机复制 --- 新建

SDK方法名：createCdm;

URL

/cdm

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
fsp_backup	Object
secret_key	String
band_width	String
mirr_open_type	String			0
service_uuid	String
mirr_sync_flag	String			0
excl_path	Array			["/cgroup/","/dev/","/etc/X11/xorg.conf/","/etc/init.d/i2node/","/etc/rc.d/init.d/i2node/","/etc/sdata/","/lost+found/","/media/","/mnt/","/proc/","/run/","/selinux/","/sys/","/tmp/","/usr/local/sdata/","/var/i2/","/var/i2data/","/var/lock/","/var/run/vmblock-fuse/"]
bkup_one_time	Number			0
encrypt_switch	String			0
mirr_sync_attr	String			1
bk_uuid	String			F85DFEC0-149E-373D-0B9E-3DA9A5C43940
wk_data_type	Number			1
bk_path	Array			["/fsp_bk/"]
sync_item	String			/
bkup_policy	Number			2
start_type	Number		启动方式： 0：立即启动； 1：手动启动； 2：预约启动；	0
mirr_file_check	String			0
compress	String			0
monitor_type	Number			0
failover	String			0
wk_path	Array			["/"]
fsp_name	String			test
wk_uuid	String			42614852-BB62-1EF7-FED0-D2354BF3149D
fsp_wk_shut_flag	String			2
bk_data_type	Number			1
bkup_schedule	Array
sched_day	String			@integer(1, 31)
sched_time	String			@time('HH:mm')
sched_every	Number			2
limit	String			@integer(1, 64)
backup_type	Number			0
policys	String			"每天22:00自动执行"
backup_type_show	String			"全备"
running_time	String			"22:00"
fsp_type	Number			3
del_policy	Number			1
timeout	Number			1
cbt_switch	Number			1
threshold_vaild_byte	String
advanced_policy	Object
bk_cdp	Number			1
execute_interval	Number			1
cdp_detail	Number			1
cdp_daily	Number			1
cdp_param	String
cdp_switch	Number			1
cdp_snapshot_days	Number			1
cdp_snapshot_execute_interval	Number			1
vp_uuid	String
storage_uuid	String
data_ip_uuid	String
database_switch	Number		是否开启数据库保护： 0：未开启； 1：开启	0
database_type	String		0：oracle； 1： mysql；（task6526暂时屏蔽） 2： mssql; 3: custom;	0
oracle_dbagent_param	Object
oracle_sid	String
sql_plus_path	String
username	String
password	String
port	Number
table_space	Array
timeout	Number
mysql_dbagent_param	Object
mysql_path	String
username	String
password	String
port	Number
database_name	Array
timeout	Number
sqlserver_dbagent_param	Object
timeout	Number
enable	Number		0,1	0
custom_dbagent_param	Object
pre_snapshot_script	String		开始数据库保护并且选择自定义保护时不可为空
post_snapshot_script	String		同上不可为空
auto	String		是否自动演练
orch_vm_name	String		演练虚机名称
scripts_type	String		自动验证方式 0：ping验证。1.端口验证。2脚本验证
scripts	String		自动验证脚本内容-base64

Response

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

整机复制 --- 获取单个

SDK方法名：describeCdm；

URL

/cdm/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
code	Number			0
message	String
rep_backup	Object
cdp_path	String
disk_limit	String			0
policy_operation	Number			1
rep_uuid	String			EFB53F11-7BA2-2001-3418-85865EA58E47
policy_interval	Number			1
mirr_sched	String			303:00-14:00,202:00-15:00
policy_limit	Number			1
encrypt_switch	Number			0
random_str	String			0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
auto_start	Number			1
del_policy	Number			1
cdp_bl_sched_switch	Number			0
rep_type	Number			0
cdp_bl_bkup_switch	Number			0
cdp_param	String
rep_name	String			rrrrr
compress	Number			0
bk_port	String			26831
mirr_sync_flag	Number			0
cdp_baseline_format	Number			0
file_type_filter	String
snapshot_policy	Number			1
bk_ip	String			0.0.0.0
snapshot_switch	Number			0
wk_port	String			26821
band_width	String			303:00-14:002m,202:00-15:0080m
group_uuid	String			0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
file_check	Number			1
cdp_process_time	String
oph_path	String
create_time	String
user_uuid	String			0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
excl_path	Array
secret_key	String
schedule	String
bk_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
bk_path_policy	Number			1
snapshot_start	Number			1515568566
cdp_switch	Number			1
snapshot_interval	Number			1
wk_ip	String			0.0.0.0
oph_policy	Number			0
mirr_sync_attr	Number			1
wk_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
policy_start	Number			1
file_type_filter_switch	Number			0
bkup_one_time	Number			1515568566
mirr_sched_switch	Number			0
cdp_bl_sched	String			2|0	0
mirr_open_type	Number			0
snapshot_limit	Number			23
wk_path	Array			["D:\DataTest\"]
mirr_file_check	Number			0
mirr_skip	String			0
bk_path	Array			["D:\DataTest2\"]
cdp_data_inc	Number			1
cdp_data_inc_switch	Number			1
cdp_data_inc_flag	String
latency_threshold	Number			1
mscs_autostart	Number			1
mir_detect_script	String
filter_delete	Number			0
cmp_limit	String
data_ip_uuid	String			A7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
ret	Number			200
msg	String

整机复制 --- 修改

SDK方法名：modifyCdm;

URL

/cdm/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
fsp_backup	Object
secret_key	String
band_width	String
mirr_open_type	String			0
service_uuid	String
mirr_sync_flag	String			0
excl_path	Array			["/cgroup/","/dev/","/etc/X11/xorg.conf/","/etc/init.d/i2node/","/etc/rc.d/init.d/i2node/","/etc/sdata/","/lost+found/","/media/","/mnt/","/proc/","/run/","/selinux/","/sys/","/tmp/","/usr/local/sdata/","/var/i2/","/var/i2data/","/var/lock/","/var/run/vmblock-fuse/"]
bkup_one_time	Number			0
encrypt_switch	String			0
mirr_sync_attr	String			1
bk_uuid	String			F85DFEC0-149E-373D-0B9E-3DA9A5C43940
wk_data_type	Number			1
bk_path	Array			["/fsp_bk/"]
sync_item	String			/
bkup_policy	Number			2
mirr_file_check	String			0
compress	String			0
monitor_type	Number			0
failover	String			0
wk_path	Array			["/"]
fsp_name	String			test
wk_uuid	String			42614852-BB62-1EF7-FED0-D2354BF3149D
fsp_wk_shut_flag	String			2
bk_data_type	Number			1
bkup_schedule	Array
sched_day	String			@integer(1, 31)
sched_time	String			@time('HH:mm')
sched_every	Number			2
limit	String			@integer(1, 64)
backup_type	Number			0
policys	String			"每天22:00自动执行"
backup_type_show	String			"全备"
running_time	String			"22:00"
fsp_type	Number			3
random_str	String			11111111-1111-1111-1111-111111111111
del_policy	Number			1
timeout	Number			1
cbt_switch	Number			1
threshold_vaild_byte	String
advanced_policy	Object
bk_cdp	Number			1
execute_interval	Number			1
cdp_detail	Number			1
cdp_daily	Number			1
cdp_param	String
cdp_switch	Number			1
cdp_snapshot_days	Number			1
cdp_snapshot_execute_interval	Number			1
vp_uuid	String
storage_uuid	String
data_ip_uuid	String
oracle_dbagent_param	Object
oracle_sid	String
sql_plus_path	String
username	String
password	String
port	Number			1
table_space	Array
timeout	Number			1
mysql_dbagent_param	Object
mysql_path	String
username	String
password	String
port	Number			1
database_name	Array
timeout	Number			1
sqlserver_dbagent_param	Object
timeout	Number			1
enable	Number			0
database_type	String			0
database_switch	Number			0
auto	String
orch_vm_name	String
scripts_type	String
scripts	String
start_type	Number			0

Response

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

整机复制 --- 列表

方法名：listCdm;

URL

/cdm

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number		任务类型： 8代表整机复制	3
limit	Number		分页条数	10
page	Number		页数	1
where_args	Array		多重复合搜索条件，整机复制规则迁移时所需条件 where_args[wk_uuid]="" where_args[vp_uuid]="" where_args[storage_uuid]=""
status	String		可选，总览页面跳转时按照状态过滤时需要 WAIT MAINTAIN REPLICATION FINISH STOP UNKNOWN

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
info_list	Array
band_width	String		带宽配置	2400:00-22:594m
bk_path_policy	String		一对一；多对一	0
random_str	String		随机字符串	0E807AD3-DD1E-9224-2B9B-E713CF258467
wk_node_name	String		工作机名称	name
bk_node_name	String		灾备机名称	name
username	String		用户名	admin
bk_uuid	String		灾备机uuid	F28184D8-869B-BF56-A77C-3CC835FAAC35
fsp_name	String		规则名称	asdasddsasdasd
fsp_type	String		规则类型	8
fsp_uuid	String		规则uuid	E28184D8-869B-BF56-A77C-3CC835FAAC34
wk_uuid	String		工作机uuid	0E807AD3-DD1E-9224-2B9B-E713CF258467
bkup_schedule	Array
backup_type_show	String		备份计划	全备
policys	String		备份策略	每天22:00自动执行
backup_type	String		备份类型	0
sched_every	String		每隔多久	0
running_time	String		运行时间	22:00
sched_time	Array		计划：时间	["22:00"]
sched_day	Array		计划：天
limit	String		保留数量	1
can_op	Number		允许操作	1
can_del	Number		允许删除	1
can_up	Number		允许更新	1
resource_settings	Object		整机备份-资源配置相关设置
vm_list	Array		虚机列表
vm_name	String		工作机名称	vm_name
new_vm_name	String		目标机名称	new_vm_name
custom_config	String		自定义设置-1:打勾，0:不打勾	0
cpu	String		cpu数量	2
core_per_sock	String		核心数	2
mem_mb	String		内存	1024
dynamic_mem	String		是否开启动态内存	0
networks	Array		网卡信息
source_network_name	String		源机网卡名称	source_network_name
mac_address	String		mac地址	08：00：20：0A：8C：6D
keep_mac	String		保留mac地址	0
network_id	String		网卡id	network_id
network_name	String		网卡名称	network_name
disk_list	Array		磁盘列表
is_ignored	String		磁盘名称	0
disk_name	String		磁盘名称	VMware Virtual disk 1.0
disk_path	String		磁盘路径	/
new_ds	String		存储	NFS-172.20.67.90--250496693
id	String
tgt_uuid	String		目标平台uuid	0E807AD3-DD1E-9224-2B9B-E713CF258467
new_dc	String		数据中心	ha-datacenter
new_host	String		主机	localhost.localdomain"
new_ds	String		存储	disk (1)
new_dc_mor	String			ha-datacenter
network_name	String		网卡名称	vm4
network_id	String		网卡id	''
bk_uuid	String		灾备机uuid	0E807AD3-DD1E-9224-2B9B-E713CF258467
bk_path	String		备份路径	/disk
verify_settings	Object		验证配置
add_drill	String		是否开启验证	0
auto	String		是否自动验证	0
drill_plat_uuid	String		演练平台uuid	0E807AD3-DD1E-9224-2B9B-E713CF258467
vm_list	Array		虚机列表
vm_name	String		虚机名称	vm_name
orch_vm_name	String		新虚机名称	orch_vm_name
scripts_type	String		验证方式	0
scripts	String		验证内容	''
wk_data_type	String		源类型	0
bk_data_type	String		目标端类型	7
bkup_policy	String		备份策略	1
total	Number			1

整机复制 --- 状态

方法名：listCdmStatus

URL

/cdm/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
fsp_uuids	Array		必传，uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取；	["11111111-1111-1111-1111-111111111111"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
message	String
status	Object
fsp_uuid	String		@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
f_total	String		@mock=0, ? 默认0	0
progress	String		@mock=0, 进度	0
status	String		@mock=STOP, 状态文字	STOP
db_status	String		@mock=, ？默认空
latency	Number		复制延迟，ms单位	10
wk_status	String		工作机状态，ONLINE,OFFLINE	ONLINE
version_number	Number		备份数	10
validated_version_number	Number		有效备份数	10
code	Number			0
count	Number			0

整机复制 --- 根据工作机获取规则

SDK方法名：getByWk;

URL

/cdm/get_by_wk

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String		工作节点uuid
vp_uuid	String		（可选）平台uuid。新建挂接等规则时切换平台时赋值，确定整机复制平台。迁移规则后会出现一个工作机对应两个平台的情况。

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
cdm	Object
id	String			1
auto_start	String			1
band_width	String
bkup_one_time	Number			0
bkup_policy	Number			2
bkup_schedule	Array
compress	String			0
cmp_file_check	String			0
cmp_schedule	Null
cmp_switch	String			0
create_time	String			1606974951
encrypt_switch	String			0
mirr_file_check	String			0
mirr_open_type	String			0
mirr_sync_attr	String			1
mirr_sync_flag	String			0
mirr_skip	String			0
random_str	String			A7CF6F34-E4C3-9AC7-A17C-0C16CEB6332A
secret_key	String
snapshot_interval	String			24
snapshot_limit	String			24
snapshot_policy	String			0
snapshot_start	Null
snapshot_switch	String			0
bk_path_policy	String			1
uuid	String			EA3D09E2-DFD5-F8E5-4311-259BFD4A7287
del_policy	Number			0
thread_num	String			1
file_type_filter	Null
file_type_filter_switch	String			0
cmp_sync_file	String			1
state	Object
fsp_uuid	String			EA3D09E2-DFD5-F8E5-4311-259BFD4A7287
status	String			FINISH
version_number	Null
validated_version_number	Null
latency	Number			0
runtime_switch	String			0
runtime_range	Null
filter_delete	String			0
cmp_limit	Null
wk_node_name	String			172.20.67.251
bk_node_name	String			172.20.67.242-back
wk_ip	String			172.20.67.251
wk_port	String			26821
bk_ip	String			172.20.67.242
bk_port	String			26821
username	String			admin
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
backup_type	String			0
boot_time	Null
excl_path	Array
failover	String			0
fsp_name	String			67.251-ffo
fsp_type	Number			8
fsp_uuid	String			EA3D09E2-DFD5-F8E5-4311-259BFD4A7287
fsp_wk_shut_flag	String			2
wk_path	Array
path	String			PhysicalDrive1\
name	String			PhysicalDrive1
icon	String			folder
size	Number			48315294720
file	String
attr	Number			0
leaf	String
subNodes	Array
children	String
has_policy	String
name	String			E:
size	Number			48315236352
leaf	String			1
is_dir	String
attr	Number			0
nodeUuid	String			9ED08024-6268-F977-BB80-EB6A7D055A33
showSize	String			45.00 GB
disabled	String
has_policy	String
is_show	String
wk_data_type	Number			0
heartbeat	Null
max_fail_times	Null
monitor_ips	String
monitor_type	Number			0
move_type	Null
net_mapping	Array
net_mapping_type	String			0
post_over_script	Null
pre_over_script	Null
recovery_data_path	Null
restore_point	Null
running_service	Array			["sshd"]
snapshot	String			0
wk_uuid	String			9ED08024-6268-F977-BB80-EB6A7D055A33
status	String			FINISH
sync_item	String
bk_path	Array			[""]
bk_uuid	String			5781FFD6-75B5-0479-32F3-D0AE85427A83
bk_data_type	Number			7
timeout	Number			0
excl_driver	Array
cbt_switch	Number			0
threshold_vaild_byte	String			128
advanced_policy	Object
bk_cdp	Number			0
execute_interval	Number			5
cdp_daily	Number			1
cdp_param	String
cdp_switch	Number			0
cdp_snapshot_execute_interval	Number			1
cdp_snapshot_days	Number			1
vp_uuid	String			1EA61ECF-BEB4-CA12-6E6D-7A3556D1A8E9
storage_uuid	String			5F51D353-082F-65E6-DB89-0DC86459DECD
group_uuid	Null
proxy_uuid	Null
by_type	Number			0
bak_wk_uuid	Null
bak_wk_address	Null
bak_wk_name	Null
biz_grp_list	Array
biz_grp_name	Array
is_biz_admin	Number			1
can_del	Number			1
can_op	Number			1
can_up	Number			1

备份点列表

SDK方法名：getPointList;

URL

/cdm/point_full_info_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否
path	String	否	非CDM：bk_path/工作机ip_工作机port； CDM：storage的path
type	String	否	非CDM：空； CDM：storage的type(localfs,nfs,gluesterfs)
suffix	String	否	非CDM：空； CDM：工作机ip_工作机port
page	Number		页码
limit	Number		每页条数
rule_uuid	String		备份规则uuid；不传或传空则获取所有
search_key	String		过滤条件： DATA_USE：备份点占用说明
search_value	String		按DATA_USER过滤时： 0：未占用； 1：占用； 2：默认值，表示所有	2
start	Number		查询起始时间戳，非必填
end	Number		查询结束时间戳，非必填
order	String		查询顺序，默认正序：DESC，倒叙：ASC

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
data	Object	否
message	String	否		[0] success
code	Number	否		0
list	Array	否			10
restorepoint	String	否	还原时间点	2020/03/18 09:50:00
type	Number	否	全量0，增量1
snapshot	Number		1是快照，0不是快照
snapshot_timestamp	String		快照时间戳。记录当前cbt对应的快照
disks	Array	否			3
path	String	否	磁盘路径
size	String	否	磁盘大小单位MB	1024
index	Number	否	磁盘顺序	1
isBoot	Number	否	是否启动盘，0：否；1，是	1
interface	String	否	0 为 ide，1 为 scsi, 2 为 virtual ide
group	String
os_version	String	否	操作系统版本Microsoft Windows Server 2012	Microsoft Windows Server 2012
mem_size	String	否	memory大小 单位MB	1024
cpu_cores	String	否	cpu 个数	4
bios_type	String	否	可能的类型有 legacy 和 uefi 默认 legacy
network	Object	否
cards	Array	否			3
mac	String	否
cidr	Array		ip/mask对		+1
gateway	Array	否
dns	Object	否
domain	String	否		@ip
servers	Array	否
type	String	否	网卡类型，0物理网卡，1虚拟网卡
name	String		网卡名
dns	Object	否
domain	String	否		@ip
servers	String	否		@ip
timezone	String	否	时区
rep	Number		默认值0，1表示实时数据，2表示可用数据	0
backup_data_size	String		备份数据大小，单位字节
has_virtio	String		是否安装 viostor 驱动	'false'
has_virtio_scsi	String		是否安装 vioscsi 驱动	'false'
has_net_kvm	String		是否安装 netkvm 驱动	'false'
rule_uuid	String		备份规则uuid	@guid
cdm_rule_num	Number		接管/演练 数量
ffo_mount_num	Number		挂接任务 数量
auto_drill_num	Number		自动演练数量	@integer(0,4)
total	Number		总数
msg	String	否

获取网卡列表

SDK方法名：getNetworkList;

URL

/cdm/network_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		容灾平台uuid
type	String		0：接管； 1：演练；
storage_id	String		存储id

Response

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

获取单个

SDK方法名：describeFfomount;

URL

/ffo_mount/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
ffo_mount	Object
vp_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
bk_version	String			bkVersion
os_version	String			osVersion
storage_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
mount_name	String			mountTask
wk_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
bk_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
vm_disks	Array
path	String			path
size	String			10240
interface	String			interface
isBoot	String			1
protocol	String			iSCSI
acl	String
fsp_uuid	String
data_ip_uuid	String			A7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
code	Number			0

根据存储获取工作机列表

SDK方法名：getNodeList;

URL

/cdm/restore_node_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String		灾备机uuid
path	String		存储的path
type	String		存储的type

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
list	Array
name	String		工作机名称 或者 地址 用于 显示在页面 让用户选择
directory	String		工作机备份数据目录， 例如 192.168.1.120_26821
ret	Number			200

获取资源列表

SDK方法名：getResourceList;

URL

/cdm/drp_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否	分页条数	10
page	Number	否	页数	1
search_field	String	否	按条件过滤字段名	''
search_value	String	否	按条件过滤值	''

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
info_list	Array	否
vp_uuid	String	否	容灾平台uuid	C0744ABF-5571-8288-1930-439612B6234A
vp_name	String	否	容灾平台名称	vp_name
status	String	否	容灾平台状态	ONLINE
cpu_total	String	否	CPU核数	8
cpu_used	String	否	CPU使用量	6
cpu_mhz	String		CPU赫兹总量	3.20
cpu_usage	String	否	CPU使用率	0
mem_total	String	否	内存总数	1024
mem_used	String	否	内存使用数量	1024
mem_usage	String		内存使用率	0
storage_total	String	否	存储总数	0
storage_used	String	否	已使用存储数	0
storage_usage	String		存储使用率	0
vm_total	String	否	虚机总数	0
vm_running	String	否	虚机运行数	0
network_total	String		网卡总数	0
hosts	Array	否
name	String	否	主机名
cpu_total	String		cpu总数	0
cpu_mhz	String		cpu赫兹	3.20
cpu_usage	String	否	CPU使用率	0
mem_total	String	否	总内存	1024
mem_used	String	否	已使用内存	0
ip	String	否	主机ip	127.0.0.1
connection_state	String		Vcenter中，主机的连接状态。	''
uuid	String		主机硬件识别码
storages	Array	否
storage_id	String	否	storage id	storage
name	String	否	存储名	name
total	String	否	总数btye	0
used	String	否	已使用byte	0
type	String	否	Local, NFS, GlusterFS	Local
path	String	否	eg, /a/b/c/d for Local AND 172.20.16.21:/mnt/a for NFS/GlusterFS	/
enabled	Number	否	是否已授权，0否，1是	0
managed_hosts	Array		接管主机资源列表
name	String		名称	managed_hosts_name
cpu_total	String		cpu总数	16
cpu_mhz	String		cpu赫兹	3.20
cpu_usage	String		cpu使用率	0
mem_total	String		内存总数	1024
mem_used	String		内存使用数	1024
ip	String		地址	127.0.0.1
connection_state	String		Vcenter中，主机的连接状态。	''
orch_hosts	Array		演练主机资源列表
name	String		名称	orch_hosts_name
cpu_total	String		cpu总数	16
cpu_mhz	String		cpu赫兹	3.20
cpu_usage	String		cpu使用率	0
mem_total	String		内存总数	1024
mem_used	String		内存使用数	1024
ip	String		地址	127.0.0.1
connection_state	String		Vcenter中，主机的连接状态。	''
total	Number	否		1

获取主机存储资源

SDK方法名：getHostStorageList;

URL

/cdm/host_storage_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String	否	容灾平台uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
ret	Number	否		200
data	Object	否
message	String	否
code	Number	否		0
hosts	Array	否
name	String	否
ip	String	否		172.20.2.80
uuid	String		主机硬件识别码
storages	Array	否
storage_id	String	否	storage id	1
name	String	否
total	String	否
used	String	否
type	String	否
path	String	否

按虚机恢复获取磁盘

SDK方法名：getVmInfo;

URL

/cdm/vm_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		容灾平台uuid
bk_uuid	String		灾备机uuid
vm_ref	String		虚机id

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
vm_disks	Array
id	String
name	String
path	String
size	String
isBoot	String

获取自动演练备份点列表并刷新自动演练规则虚机对应关系

获取cdm对应演练记录里的虚机列表

URL

/cdm/auto_drill_restore_point_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String		CDM整机复制规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
code	String
msg	String
list	Array
uuid	String		演练规则uuid
restorepoint	String		还原点名

------ 整机恢复 ------

整机恢复模块继承全服恢复；列表、状态等接口，详见 “webapi-定时数据备份 - 全服务器保护“

URL

/dash/cdm_recovery

Method

GET

Request

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

Response

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

整机恢复 --- 新建

SDK方法名：createCdmRecovery;

URL

/cdm_recovery

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
fsp_recovery	Object
fsp_name	String		名称	testRC
by_type	String		0：按工作机；1：按存储；2：按虚拟机
bak_wk_uuid	String		by_type为0时传：工作机uuid；
bak_wk_address	String		by_type为1时传：工作机地址；
bak_wk_name	String		by_type为1时传：工作机名称；
vm_name	String		by_type为2时传，虚机名称;
vm_ref	String		by_type为2时传，虚机id;
vp_uuid	String		容灾平台uuid
storage_uuid	String		存储uuid
bk_uuid	String		灾备机uuid	F85DFEC0-149E-373D-0B9E-3DA9A5C43940
restore_point	String		备份点	20190111113656
wk_uuid	String		还原目标机uuid	42614852-BB62-1EF7-FED0-D2354BF3149D
bk_path	Array		源磁盘	["/fsp_bk/192.168.71.77_26821/20190111113656/","/fsp_bk/192.168.71.77_26821/20190111113656/bin/","/fsp_bk/192.168.71.77_26821/20190111113656/boot/","/fsp_bk/192.168.71.77_26821/20190111113656/etc/","/fsp_bk/192.168.71.77_26821/20190111113656/lib/","/fsp_bk/192.168.71.77_26821/20190111113656/lib64/","/fsp_bk/192.168.71.77_26821/20190111113656/root/","/fsp_bk/192.168.71.77_26821/20190111113656/sbin/","/fsp_bk/192.168.71.77_26821/20190111113656/usr/bin/","/fsp_bk/192.168.71.77_26821/20190111113656/usr/lib/","/fsp_bk/192.168.71.77_26821/20190111113656/usr/lib64/","/fsp_bk/192.168.71.77_26821/20190111113656/usr/libexec/","/fsp_bk/192.168.71.77_26821/20190111113656/usr/local/","/fsp_bk/192.168.71.77_26821/20190111113656/usr/sbin/","/fsp_bk/192.168.71.77_26821/20190111113656/var/lib/nfs/"]
wk_path	Array		目标磁盘	["/","/I2FFO/bin/","/I2FFO/boot/","/I2FFO/etc/","/I2FFO/lib/","/I2FFO/lib64/","/I2FFO/root/","/I2FFO/sbin/","/I2FFO/usr/bin/","/I2FFO/usr/lib/","/I2FFO/usr/lib64/","/I2FFO/usr/libexec/","/I2FFO/usr/local/","/I2FFO/usr/sbin/","/I2FFO/var/lib/nfs/"]
dst_path	String			''
monitor_type	Number			0
net_mapping	Array
bk_nic	Object
type	String			0
name	String			Ethernet0
ip	String			192.168.72.74/255.255.240.0
wk_nic	Object
name	String			Ethernet0
type	String			0
ip	String			192.168.72.73/255.255.240.0
mirr_sync_attr	String			1
band_width	String
net_mapping_type	String			2
mirr_open_type	String			0
mirr_file_check	String			0
service_uuid	String
excl_path	Array
mirr_sync_flag	String			0
fsp_wk_shut_flag	String			2
sync_item	String			/
failover	String			0
fsp_type	String			5
random_str	String			11111111-1111-1111-1111-111111111111
data_ip_uuid	String			F85DFEC0-149E-373D-0B9E-3DA9A5C43940
compress_switch	Number		压缩开关： 0：关； 1：开；
compress	Number		压缩等级：
encrypt_switch	Number		加密开关： 0：关； 1：开；
encrypt	String		加密类型： 0：不加密， 1：AES， 2：SM4，
secret_key	String		加密key

Response

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

整机恢复 --- 操作

SDK方法名：operateCdmRecovery;

URL

/cdm_recovery/operate

Method

POST

Request

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

Response

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

整机恢复 --- 列表

SDK方法名：listCdmRecovery;

URL

/cdm_recovery

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
search_value	String		, 可选，搜索字段对应值（可以模糊）	''
search_field	String		, 可选，搜索字段	''
page	Number		, 可选，不传就是全部	1
limit	Number		, 可选，不传就是全部	10

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
count	Number			10
total	Number			100
message	String
info_list	Array
wk_node_name	String		@mock=@pick(["Smith", "Will", "Nary"]), 源节点名	@pick(["Smith", "Will", "Nary"])
wk_path	String		@mock=C:\123, 源路径	C:\123\
fsp_uuid	String		@mock=@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]), 规则UUID	@pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"])
username	String		@mock=@pick(["admin", "user", "super"]), 用户名	@pick(["admin", "user", "super"])
excl_path	String		@mock=, 排除路径
bk_uuid	String		@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 目标节点名	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
bk_path	String		@mock=C:\ascasldfjlksjf, 目标节点路径	C:\ascasldfjlksjf\
fsp_name	String		@mock=testbak, 规则名	testbak
wk_uuid	String		@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 源节点uuid	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
band_width	String		@mock=@pick(["100", "150", "200"]), 带宽控制	@pick(["100", "150", "200"])
bk_node_name	String		@mock=@pick(["kevin", "Jane", "Grey"]), 目标节点名	@pick(["kevin", "Jane", "Grey"])
fsp_type	String		任务类型： 9代表整机恢复	9
can_up	Number			1
can_op	Number			1
can_del	Number			1
state	Object		状态 - 后台任务获取，统计专用
fsp_uuid	String			C829B94A-85F2-F8C8-16F6-B203EE2EFA5E
latency	Number			0
status	String			FINISH
time	Number			1629096647
validated_version_number	Null
version_number	Null
wk_status	String			ONLINE

整机恢复 --- 状态

SDK方法名： listCdmRecoveryStatus

URL

/cdm_recovery/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
fsp_uuids	Array		必传，uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取；	["11111111-1111-1111-1111-111111111111"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
status	Object
fsp_uuid	String		@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 规则uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
status	String		@mock=STOP, 状态文字： UNKNOWN：未知； PREPARE：准备； NEGO：协商； CALC：计算中； MIRROR：镜像； FSP_RC_IDLE：还原就绪； FSP_WAITING：还原中； FFO_DONE：重启就绪； FINISH：完成 ； STOP：停止；	STOP
progress	String		@mock=0, 进度	0
version_number	String		无效值	null
validated_version_number	String		无效值	null
latency	Number		无效值	0
wk_status	String		还原目标机状态	ONLINE
count	Number		@mock=0, ? 默认0	0
message	String
code	Number		@mock=200	0

----- 接管/演练 -----

URL

/dash/cdm_rule

Method

GET

Request

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

Response

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

接管/演练 --- 列表

SDK方法名：takeOverDrillList;

URL

/cdm_rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否	分页条数	10
page	Number	否	页数	1
where_args	Array	否
wk_uuid	String	否	工作机uuid	BC92C981-D637-AC10-7CB0-450504DF8A3C
bk_uuid	String	否	灾备机uuid	BC92C981-D637-AC10-7CB0-450504DF8A3C

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
count	Number	否		10
info_list	Array	否
rule_uuid	String	否	规则uuid	BC92C981-D637-AC10-7CB0-450504DF8A3C
vm_name	String	否	虚机名称	test
rule_type	Number	否	规则类型： 0：接管； 1：演练；	0
by_type	Number		创建方式： 0：工作机； 1：存储； 2：虚机；	0
wk_uuid	String	否	工作机uuid	C0744ABF-5571-8288-1930-439612B6234A
wk_name	String	否	工作机名称	wkname
bk_uuid	String	否	灾备机uuid	C0744ABF-5571-8288-1930-439612B6234A
bk_name	String	否	灾备机名称	bkname
bk_version	String	否	灾备机版本	7.1.57.19111521
vm_cpu_core	String	否	虚机cpu核心数	2
vm_mem	String	否	单位MB	1024
vm_disks	Array	否
path	String	否	(*必填）磁盘路径	/
size	String	否	(*必填）磁盘大小单位MB	2048
terface	String	否	(*必填）0 为 ide，1 为 scsi, 2 为 virtual ide	0
isBoot	String	否	(*必填）是否启动盘	0
vm_network	String	否	网卡名	Network Name
vm_ref	String	否	虚机ID	100
can_del	Number			1
total	Number	否		100
code	Number	否		0
message	String	否
msg	String	否
ret	Number	否		200

接管/演练 --- 新建

SDK方法名：createTakeOverDrill;

URL

/cdm_rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vm_name	String	否	新虚机名称 限制不能使用以下字符 ： '",;/<>:*?%|$[]
rule_type	Number	否	(*必填）类型 0 为接管 1 为演练
vp_uuid	String	否	(新)容灾平台vp_uuid
by_type	Number		0：按工作机；1：按存储
wk_uuid	String	否	工作机uuid，by_type为0时必传
wk_address	String		工作机地址，by_type为1时必传
wk_name	String		工作机名称，by_type为1时必传
bk_uuid	String	否	备机uuid
bk_path	String	否	留空''
storage_uuid	String	否	存储的storage_uuid
bk_version	String	否	(*必填）备份点
vm_cpu_core	String	否	(*必填）新虚机cpu个数
vm_mem	String	否	(*必填）新虚机memory大小 单位MB
network_switch	Number		是否开启自定义网络配置： 0：否； 1：是;	0
vm_network	Object	否	(*必填）网卡
cards	Array	否
mac	String	否
cidr	Array		ip/mask对
gateway	Array	否
dns	Object	否
domain	String	否
servers	Array	否
network_id	String		网卡id
network_name	String		网卡名称
dns	Object	否
domain	String	否
servers	String	否
vm_disks	Array	否
path	String	否	(*必填）磁盘路径
size	String	否	(*必填）磁盘大小单位MB
interface	String	否	(*必填）0 为 ide，1 为 scsi, 2 为 virtual ide
isBoot	String	否	(*必填）是否启动盘，0：否；1，是
bios_type	String	否	可能的类型有 legacy 和 uefi 默认 legacy
os_version	String	否	操作系统版本Microsoft Windows Server 2012
timezone	String	否	时区
fsp_uuid	String		整机复制uuid，必传
has_virtio	String		是否安装 viostor 驱动	'false'
has_virtio_scsi	String		是否安装 vioscsi 驱动	'false'
has_net_kvm	String		是否安装 netkvm 驱动	'false'
restore_info	Object		所有备份点信息

Response

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

接管/演练 --- 删除

SDK方法名：deleteTakeOverDrill;

URL

/cdm_rule

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array	否
force	Number		1 - 强制删除 0 - 非强制删除
del_policy	Number		是否删除目标虚机，0，1	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			节点离线
rule_uuid	String			BC92C981-D637-AC10-7CB0-450504DF8A3C
vm_name	String			test2
success_list	Array
code	Number			11110001
message	String			删除成功
rule_uuid	String			AB92C981-D637-AC10-7CB0-450504DF8A3C
vm_name	String			test1
ret	Number			200

接管/演练 --- 获取单个

SDK方法名：describeTakeOverDrill;

URL

/cdm_rule/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
cdm_rule	Object	否
rule_uuid	String	否		C0744ABF-5571-8288-1930-439612B6234A
vm_name	String	否		test
rule_type	Number	否		0
wk_uuid	String	否		C0744ABF-5571-8288-1930-439612B6234A
wk_ip	String	否	工作机ip	172.20.2.201
wk_port	String	否	工作机端口	1828
bk_uuid	String	否		C0744ABF-5571-8288-1930-439612B6234A
bk_path	String	否	备份路径	bk_path
bk_version	String	否		bkVersion
vm_cpu_core	String	否		3
vm_mem	String	否	单位MB	2
vm_disks	Array	否
path	String	否	(*必填）磁盘路径	path
size	String	否	(*必填）磁盘大小单位MB	1020
interface	String	否	(*必填）0 为 ide，1 为 scsi, 2 为 virtual ide	1
isBoot	String	否	(*必填）是否启动盘	1
vm_network	String	否		network
vm_ref	String	否	虚机ID	334
fsp_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
data_ip_uuid	String			A7EC7CF9-FCA2-D467-ECD6-E028AA9C8319
vp_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
storage_uuid	String			C0744ABF-5571-8288-1930-439612B6234A
code	Number	否		0

接管/演练 --- 获取虚机状态

SDK方法名：getVmStatus;

URL

/cdm_rule/vm_status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array	否	规则uuid	['0E807AD3-DD1E-9224-2B9B-E713CF258467', '1A807AD3-DD1E-9224-2B9B-E713CF258467']
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
status	Array	否
rule_uuid	String	否	规则uuid	BC92C981-D637-AC10-7CB0-450504DF8A3C
status	String	否	状态可能是： CREATING: 正在创建 (禁止其它操作) RESTORING: 正在回切 (禁止其它操作) IMAGE_LOCKED : 虚机关机，且虚机不能开，因为磁盘正在被操作 (禁止其它操作) CREATE_FAILED: 创建失败 （只允许删除操作） DOWN: 关机 （允许 删除 和开机 操作） POWERING_DOWN：正在关机 (禁止其它操作) POWERING_UP: 正在开机 (允许 关机 和 打开控制台 操作) WAIT_FOR_LAUNCH：将要开机 (禁止其它操作) UP： 虚机正在运行 （允许 关机 和 打开控制台 操作） NON_EXIST： 虚机不存在 （只允许删除操作） UNKNOWN : 未知 (禁止其它操作)	ONLINE

接管/演练 --- 操作

SDK方法名：operateTakeOverDrill;

URL

/cdm_rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array	否
operate	String	否	start/stop/open_console
type	String	否	(*选填）打开控制台操作时可传 spice, vnc

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
code	Number	否		0
message	String	否		success
file_name	String	否	文件名 open_console时返回
file_content	String	否	文件内容 open_console时返回
ret	Number	否		200
msg	String	否

------ 挂接任务 ------

URL

/dash/ffo_mount

Method

GET

Request

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

Response

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

新建

SDK方法名：createFfoMount；

URL

/ffo_mount

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mount_name	String		挂接名称
by_type	String		0：按工作机；1：按存储
wk_uuid	String		工作机uuid，by_type为0时必传
wk_address	String		工作机地址，by_type为1时必传
wk_name	String		工作机名称，by_type为1时必传
bk_uuid	String		灾备机uuid
vp_uuid	String		容灾平台uuid
storage_uuid	String		存储uuid
bk_version	String		备份点
os_version	String		操作系统版本
protocol	String		协议， iSCSI
acl	String		如果空，表示所有客户端都可以连
vm_disks	Array
path	String		磁盘路径
size	String		磁盘大小
interface	String		0 为 ide，1 为 scsi, 2 为 virtual ide
isBoot	String		是否启动盘 0 不是 1 是
fsp_uuid	String		整机复制uuid，必传
specify_client	Number		指定客户端： 0：否； 1：是；	0
client_uuid	String		客户端uuid	''

Response

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

修改

SDK方法名：modifyFfoMount;

URL

/ffo_mount/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mount_name	String
wk_uuid	String
bk_uuid	String
vp_uuid	String
storage_uuid	String
bk_version	String
os_version	String
protocol	String
acl	String
vm_disks	Array
path	String
size	String
interface	String
isBoot	String
random_str	String
fsp_uuid	String
specify_client	Number
client_uuid	String

Response

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

列表

SDK方法名：ffoMountList;

URL

/ffo_mount

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number			10
page	Number			1
search_field	String		搜索字段： mount_name：挂接任务名称； bk_version：备份点	mount_name
search_value	String		搜索字段值	mount_name

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
count	Number			10
info_list	Array
mount_uuid	String		挂接任务uuid	@guid
mount_name	String		挂接任务名称
wk_uuid	String		工作机uuid
bk_uuid	String		灾备机uuid
wk_node_name	String		工作机名称
bk_node_name	String		灾备机名称
bk_version	String		备份点
total	Number			100
code	Number			0
message	String

获取状态

SDK方法名：listFfoMountStatus;

URL

/ffo_mount/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mount_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
mount_uuid	String		挂接任务uuid	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
status	String		已连接：CONNECTED； 未连接：UNCONNECTED； 未知：UNKNOWN； 正在创建：CREATING； 创建失败：CREATE_FAILED；	CONNECTED
time	String		当前时间	1629169301
nr_session	String		会话数量，已连接时需要显示在页面上	0
acl	String		acl
target	String		iscs 目标端名称

删除

SDK方法名：deleteFfoMount;

URL

/ffo_mount

Method

DELETE

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
message	String
code	Number			0
success_list	Array
code	String
message	String
mount_uuid	String			34A49235-12F5-4E21-205F-4D8FAACA4079
mount_name	String			mount_name
fail_list	Array
code	String
message	String
mount_uuid	String			34A49235-12F5-4E21-205F-4D8FAACA4079
mount_name	String			mount_name

环境检测 -- Oracle是否开启归档

SDK方法名：verifyOracleArchiveMode;

URL

/cdm/verify_oracle_archive_mode

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String		工作机uuid
bk_uuid	String		灾备机uuid
username	String
password	String
sqlplus_path	String
sid	String
timeout	String
port	String

Response

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

接管/演练 --- 自动演练

SDK方法名：autoDrillCdmRule;

URL

/cdm_rule/

Method

POST

Request

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

Response

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

----- 规则远程复制 -----

URL

Method

GET

Request

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

Response

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

环境检测 -- 目标机器是否存在重复规则

SDK方法名：verifyDuplicateCdmCoopyRule;

同一个规则只能在同一个目标机器远程复制一次

URL

/cdm_remote_coopy/verify_duplicate_cdm_coopy_rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
fsp_uuids	Array		远程复制规则uuid

Response

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

远程复制 - 新建

SDK方法名：createCdmRemoteCoopy;

URL

/cdm_remote_coopy

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String
prefix	String		规则前缀名，与整机复制名组合成完整规则名
old_bk_uuid	String		原灾备机uuid
old_platform_uuid	String		原平台uuid
old_storage_uuid	String		原存储
rule_uuids	Array		规则列表
proxy_uuid	String		代理
new_bk_uuid	String		目标灾备机uuid
new_platform_uuid	String		目标平台uuid
data_addr	String		目标数据地址
new_storage_uuid	String		目标存储uuid
start_type	String		0：立即执行， 1：手动启动，2：预约执行
bkup_policy	String		备份策略，3 备份完成立即执行，0 定时，1 循环；
bkup_one_time	String		定时任务，执行时间（备份策略）
bkup_schedule	Object		周期任务（备份策略）
sched_gap_min	String		间隔分钟数	60
sched_time	String		哪几点	[ "00:00:00" ]
sched_day	String		哪几天	[ "1" ]
sched_time_end	String		运行时间范围 结束	23:59
limit	String		数据保留期限（天）	5
sched_time_start	String		运行时间范围 开始	00:00
sched_every	String		0：每天；1：每周：2：每月；3：每隔；	0
compress_switch	String		压缩开关
encrypt_switch	String		加密开关
band_width	String		带宽控制

Response

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

远程复制 - 列表获取

SDK方法名：listCdmRemoteCoopy;

URL

/cdm_remote_coopy

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	String
page	String
search_value	String
search_args	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
info_list	Array				2
rule_uuid	String			@pick(['86FECFC4-c61C-f27a-CfA1-A51EA2c8B6fC', 'fb4e0dC7-39e5-9f7e-eD45-1623f56f4e44'])
src_rule_name	String		整机复制规则名	@first
rule_name	String		远程复制规则名	@first
wk_name	String		工作机名	@last
old_bk_name	String		旧灾备机名	@first
new_bk_name	String		新灾备机名	@last
old_storage_name	String		旧存储名	@first
new_storage_name	String		新存储名	@last
status	String		等待WATTING、停止STOP、完成SUCCESS、镜像MIRROR	@pick(['STOP', 'WAIT'])
can_op	Number		可以操作	1
can_del	Number		可以删除	1
user_name	String		规则所属者	@first
old_rule_info	Array		提供前端页面获取备份点参数
bk_uuid	String		旧规则灾备机uuid
bk_path	String		旧规则灾备机备份路径
wk_ip	String		组成suffix
wk_port	String		组成suffix
rule_uuid	String		整机复制规则uuid
storage_type	String		storage的存储type
new_rule_info	Object		同上
bk_uuid	String
bk_path	String
wk_ip	String
wk_port	String
rule_uuid	String
storage_type	String
code	Number			0
total	Number			10
message	String

远程复制 - 操作

SDK方法名：{operate}CdmRemoteCoopy;

URL

/cdm_remote_coopy/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	String
operate	String		启动：start，停止：stop，迁移：migrate，立即执行：start_immediately
modify_original_rule_name	String		修改后的原规则名

Response

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

远程复制 - 状态

SDK方法名：listCdmRemoteCoopyStatus;

URL

/cdm_remote_coopy/status

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
msg	String
status	Array
rule_uuid	String			@pick(['86FECFC4-c61C-f27a-CfA1-A51EA2c8B6fC', 'fb4e0dC7-39e5-9f7e-eD45-1623f56f4e44'])
status	String		状态码	@pick(['ONLINE', 'OFFLINE'])
progress	String		进度百分比
total	String		总的传输字节数
current	String		当前传输字节数
ftotal	String		已经扫描出来的文件个数
fcur	String		已经镜像完的文件个数
blist	String		是否边遍历边镜像且正在遍历 0，未扫描 1，正在扫描

远程复制 - 删除

SDK方法名：deleteCdmRemoteCoopy;

URL

/cdm_remote_coopy

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
del_policy	String
rule_uuids	Array

Response

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

远程复制规则单独获取

SDK方法名：describeCdmRemoteCoopy;

URL

/cdm_remote_coopy/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
cdm_remote_coopy	Object
rule_uuid	String		规则uuid
user_uuid	String
wk_uuid	String		工作机uuid
old_bk_uuid	String		原灾备机uuid
new_bk_uuid	String		新灾备机uuid
old_platform_uuid	String		原平台uuid
new_platform_uuid	String		新平台uuid
old_storage_uuid	String		原存储uuid
new_storage_uuid	String		新存储uuid
data_addr	String		数据地址
bkup_policy	Number		备份类型
bkup_schedule	String		备份计划 0：一次性，1：重复，2：立即备份
compress_switch	Number		压缩开关
encrypt_switch	Number		加密开关
band_width	String		带宽
status	String		状态
old_move_uuid	String		旧整机复制uuid
new_move_uuid	String		新整机复制uuid
create_time	String		创建时间

环境检测 -- 存储空间容量检查

SDK方法名：verifyCdmCapacity;

URL

/cdm_remote_coopy/verify_cdm_capacity

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
old_storage_uuid	String		原存储uuid
new_storage_uuid	String		目标存储uuid
old_vp_uuid	String		旧平台uuid
new_vp_uuid	String		新平台uuid

Response

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

CDM 检查原备存储是否有多余CDM许可

SDK方法名：listCdmRemoteCoopyLicense;

URL

/cdm_remote_coopy/verify_license

Method

POST

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Array

CDM 备份空间检查(弃用）

SDK方法名：verifyCdmRemoteCoopyDiskSpace

URL

/cdm_remote_coopy/verify_disk_space

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
old_rule_uuids	Array		已选的整机复制uuid列表
bk_uuid	String		新灾备机uuid

Response

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

CDM 目标存储已存在目录检查

verifyCdmDirExist

URL

/cdm_remote_coopy/verify_dir_exist

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		目标存储平台uuid
storage_uuid	String		目标存储uuid
wk_uuids	Array		工作机uuid列表
bk_uuid	String		目标灾备机

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String			200
msg	String
data	Object
dir_list	Array		已存在路径字符串数组

整机复制 - 数据库保护自定义脚本检测

SDK: cdmScriptPathCheck

URL

/cdm/script_path_check

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
wk_uuid	String		工作机uuid
file_dir	String		脚本路径（多个时用逗号链接）

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Object
code	String			0
message	String
invalid_file_path	String		校验不通过时，缺失的文件路径，用逗号连接