快照任务

SDK类名：/snapshotTask/SnapshotTask;

新建

SDK方法名：createSnapshotTask；

URL

//snapshot_task

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
task_name	String			任务名称
bk_uuid	String			客户端(灾备机)uuid
copy_volume_list	Array			关联复制卷
quiet_switch	Number			启用静默快照
quiet_obj_type	Number			静默快照对象: 0-oracle、 1-mysql、 2-sqlserver、 3-rep
quiet_obj_config	Object	否		静默快照配置信息 ORACLE|MYSQL	SQLSERVER对应的配置信息
schedule	Object			快照策略
interval	Number			时间间隔
retetion_days	Number			快照保留天数
limit	Number			快照数量
type	String			0：每天；1：每周：2：每月；3：每隔 注： 目前只支持每隔
unit	Number			0: 分钟 1：小时
volume_type	Number			卷类型：0-复制卷 1-副本卷

Response

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

修改

SDK方法名：modifySnapshotTask;

下发参数同新建

URL

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

Method

PUT

Request

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

Response

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

列表

SDK方法名：listSnapshotTask；

URL

//snapshot_task

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
info_list	Array				2
bk_node_name	String		7.250
username	String		admin
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
task_uuid	Array		['16CB63E1-13FA-FB32-EB49-D790682C9648','16CB63E1-13FA-FB32-EB49-D790682C9647']		+1
task_name	String		task1
bk_uuid	String		65E3E4A5-D089-8B6A-25F3-096F6997E3F0
last_time	String		12345
next_time	String
status	String
create_time	String		1597738052
total	Number		1

删除

SDK方法名：deleteSnapshotTask;

URL

//snapshot_task

Method

DELETE

Request

名称	类型	必选	初始值	简介	Mock规则
task_uuids	Array		[ "16CB63E1-13FA-FB32-EB49-D790682C9648" ]
force	String			1 - 强制删除 0 - 非强制删除
del_snap	Number			0-不删除 1-删除

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		11110001
message	String		[0] success
success_list	Array
code	Number		11110001
message	String		[0] success
task_uuid	String		16CB63E1-13FA-FB32-EB49-D790682C9648
task_name	String		task1
fail_list	Array
code	Number		11110001
message	String		[-1] 找不到节点
task_uuid	String		16CB63E1-13FA-FB32-EB49-D790682C9647
task_name	String		task2

状态

SDK方法名：listSnapshotTaskStatus;

URL

//snapshot_task/status

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
status	Array				2
task_uuid	Array		['16CB63E1-13FA-FB32-EB49-D790682C9648','16CB63E1-13FA-FB32-EB49-D790682C9647']		+1
status	Array		['STOP', 'WAIT']		+1
last_result	String		success
last_time	String		2010-08-14 13:00:00
next_time	String		2010-08-15 13:00:00

快照任务-获取单个

SDK方法名：describeSnapshotTask;

URL

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

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
message	String
snapshot_task	Object
code	Number		0
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
snapshot_task	Object
task_name	String		task1
bk_uuid	String		65E3E4A5-D089-8B6A-25F3-096F6997E3F0
copy_volume_list	Array		["E95CB20B-917C-57F4-F926-751ECE95F869"]
quiet_switch	Number		1
quiet_obj_type	Number		0
quiet_obj_config	Object
oracle_dbagent_param	Object
enable	Boolean		true
oracle_sid	String		321
sql_plus_path	String		/st
table_space	Array		['SYSAUX', 'UNDOTBS1', 'USERS']
username	String		user
password	String		12345678
port	Number		1521
timeout	String		4444
mysql_dbagent_param	Object
mysql_path	String		/my_st
database_name	Array		['USERS', 'TEST', 'TB']
username	String		mysql_user
password	String		12345678
port	Number		3366
timeout	String		666
sqlserver_dbagent_param	Object
enable	Boolean		true
timeout	String		333
schedule	Object
interval	Number		15
retetion_days	Number		1
limit	Number		64
type	String		interval
unit	Number		1

操作

SDK方法名：{action}SnapshotTask;

URL

//snapshot_task/operate

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
operate	String		start_immediately	立即快照 - start_immediately 启动 - start 停止 - stop
task_uuids	Array		['3D7AD825-9C50-ADBA-6AC8-536B9615C40F']

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
success_list	Array
code	Number		0
message	String		[0] success
task_uuid	String		16CB63E1-13FA-FB32-EB49-D790682C9648
task_name	String		task1

获取任务快照列表

SDK方法名：listSnapshotList；

URL

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

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
page	Number		1	页数
limit	Number		10	条数
from	Number		0	按时间范围过滤，从什么时候开始
to	Number		0	按时间范围过滤，到什么时候结束

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
snapshot_list	Array
snapshot_name	String		testpool/13CB1D17-D0E7-169A-D6DC-9CFB32341989@2020-06-17-11:30:51	快照名称
snapshot_time	String		2020-06-17-11:30:51	快照时间
volume_uuid	String		13CB1D17-D0E7-169A-D6DC-9CFB32341989	复制卷uuid
volume_name	String		volume_name	复制卷名称
clone_list	Array		["testpool/13CB1D17-D0E7-169A-D6DC-9CFB32341989@2020-06-17-11:30:51_clone1","testpool/13CB1D17-D0E7-169A-D6DC-9CFB32341989@22020-06-17-11:30:51_clone2"]	副本卷
total	Number		1

删除任务快照

SDK方法名：deleteSnapshotList;

URL

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

Method

DELETE

Request

名称	类型	必选	初始值	简介	Mock规则
snapshot_list	Array
volume_uuid	String
snapshot_name	String
snapshot_time	String

Response

名称	类型	必选	初始值	简介	Mock规则
msg	String
ret	Number		200
data	Object
message	String
code	Number		0
success_list	Array
code	String
message	String
snapshot_name	String		54A49235-12F5-4E21-205F-4D8FAACA4079	快照名称
volume_uuid	String		34A49235-12F5-4E21-205F-4D8FAACA4079	复制卷uuid
volume_name	String		volume_name	复制卷名称
fail_list	Array
code	String
message	String
snapshot_name	String		54A49235-12F5-4E21-205F-4D8FAACA4079	快照名称
volume_uuid	String		34A49235-12F5-4E21-205F-4D8FAACA4079	复制卷uuid
volume_name	String		volume_name	复制卷名称