定时任务

SDK类名：/backupWork/BackupWork;

------- 定时任务 -------

URL

/dash/backup_work

Method

GET

Request

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

Response

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

定时任务 - 获取列表

SDK方法名：listBackupWork;

URL

/backup_work

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number
limit	Number
filter_uuid	String		过滤器uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String			[0] 操作成功
info_list	Array				2-5
id	String			@increment
work_uuid	String		任务ID	@uuid
work_type	Number		https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5622 任务类型： 0：备份； 1：恢复； 60：过期数据清理； 61：备份集复制； 62：备份集归档； 63：简单备份集验证； 64：详细备份集验证； 65：无效数据清理； 66：VP演练； 73：磁带擦除； 74：磁带格式化； 75：磁带浏览 76：磁带重构 77：磁带入库 78：磁带出库 79：磁带配置 80：磁带清点 81：磁带刷新； 82：无效数据清理； 92：VP文件级恢复； 93：VP瞬时恢复； 94：VP源机恢复；		1-4
status	String		任务状态: 未知：UNKNOWN； 运行：RUN； 等待：WAIT； 完成：FINISH；	@pick('RUN', 'WAITING')
state	String		状态码： 不为null就直接显示到页面上
result	Number		执行结果： SUCCESS、FAILED、STOP （未用到的字段）	@integer
progress	String		进度	@integer
start	Number		开始时间unix时间戳	123123131
end	Number		结束时间unix时间戳	234234234
task_uuid	String		任务规则uuid
wk_uuid	String		客户端uuid
wk_name	String		客户端名称	client-@first
wk_hostname	String		客户端主机名
bk_name	String		备份服务器名称	server-@first
unit_name	String		目标存储单元（组）名称	unit-@first
sched_id	String		备份策略自增id
bak_task_name	String		备份规则名称	task-@first
rc_task_name	String		恢复任务名称
replica_task_name	String		备份集复制名称
bk_set_id	String		备份集ID
ftotal	Number		文件数	@natural
trans_data_num	String		传输数据量。 当progress为-1时，展示到状态一栏中 单位：byte；
bak_task_type	Number		备份任务类型： 1：文件； 3：ORACLE 21：ORACLE RAC
unit_group_name	String		目标存储单元组名称
priority	Number		优先级
trans_mode	Number		传输链路： 0：仅TCP/IP； 1：仅LANFree； 2：LANFree优先；
library_name	String		带库名称
library_sn	String		带库序列号
library_node_name	String		带库主机名
src_unit_name	String		备份集元存储名称
src_unit_group_name	String		备份集源存储单元组名称
src_bk_name	String		备份集源备份服务器名称
vp_uuid	String		虚拟平台uuid
vp_name	String		平台名称（VP）
vp_type	Number		平台类型（VP）： 0：Vmware； 1：Hyper-V； 2：KVM； 3：容灾平台； 4：华为云,； 5：OpenStack； 7：CAS； 9：华为云Stack； 10：Fusion； 11：Winstack； 12：ECloud； 13：AIO； 14：阿里云； 15：CloudOS； 16：SCP（深信服）； 17：Zstack； 20：ARCHEROS； 21：HCSO；
code	Number			0
total	Number		总任务数	1
run	Number		运行数
wait	Number		等待数
finish	Number		完成数
stop	Number		停止数
failed	Number		失败数
skip	Number		跳过数
timeout	Number		超时数
start	Number
executing	Number
unknown	Number

定时任务 - 获取单个任务

SDK方法名：describeBackupWork;

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
code	Number			0
backup_work	Object
id	String		主键ID	@increment
work_uuid	String		定时任务UUID	@uuid
work_type	Number		https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5622 任务类型： 0：备份； 1：恢复； 60：过期数据清理； 61：备份集复制； 62：备份集归档； 63：简单备份集验证； 64：详细备份集验证； 65：无效数据清理； 66：VP演练； 73：磁带擦除； 74：磁带格式化； 75：磁带浏览 76：磁带重构 77：磁带入库 78：磁带出库 79：磁带配置 80：磁带清点 81：磁带刷新； 82：无效数据清理； 92：VP文件级恢复； 93：VP瞬时恢复； 94：VP源机恢复；	1
bkup_type	Number		备份数据类型/备份集复制类型： 0：全备； 1：增量； 2：差异； 10：D2D； 11：D2T； 12：T2D； 13：T2T；
task_uuid	String		备份规则uuid
bak_task_name	String		备份规则名称	task-@first
rc_task_name	String		恢复任务名称
wk_data_type	Number		备份规则类型： 1：文件； 3：oracle； 21：Oracle rac 22 : GaussDB(HCS)
sched_name	String		备份计划名称
priority	Number		优先级
transport	Number		数据传输方式： 0：TCP/IP； 1：LANFREE；
bk_name	String		备份服务器名称	server-@first
bk_hostname	String		备份服务器主机名
bk_host_addr	String		备份服务器地址（恢复）
bk_ip	String		备份地址（备份）
bk_port	String		备份端口（备份）
unit_name	String		目标存储单元名称	unit-@first
src_unit_name	String		备份集复制/归档： 源存储单元
library_node_name	String		机械臂主机名称
library_name	String		带库名称
library_sn	String		带库序列号
metadata_path	String		备份集元数据路径
bk_rate	String		备份速度 单位：bit/s 需要页面进一步转换，类似事件统计
progress	String		进度	@integer
ftotal	String		文件数 单位：bit	@natural
trans_data_num	String		数据量
wk_uuid	String		客户端节点UUID
wk_name	String		客户端名称	client-@first
wk_config_ip	String		客户端管理地址
wk_ip	String		客户端数据地址
wk_hostname	String		客户端主机名
bk_sets	Array		备份集发现：备份集列表
bk_object	Object		备份对象信息
wk_path	Array		文件备份规则 - 备份路径
excl_path	Array		文件备份规则 - 排除路径
rc_bk_path	Array		恢复任务 - 备份路径
rc_excl_path	Array		恢复任务 - 备份排除路径
rc_wk_path	Array		恢复任务 - 备份目标路径
ora_sid_name	String		Oracle备份规则 - 目标数据库实例名 /Oracle恢复任务 - 备份数据库实例名
ora_content_type	Number		Oracle备份规则 - 目标备份内容 /Oracle恢复任务 - 备份内容： 0：整库； 1：表空间； 2：数据文件； 3：PDBS； 4：CDB； 5：ARCHIVELOG； 6：CONTROLFILE； 7：SPFILE； 8：TABLE；
rc_ora_sid_name	String		Oracle恢复任务 - 恢复目标实例名
rc_ora_content_type	Number		Oracle恢复任务 - 恢复目标备份内容
barcode_list	Array		磁带序列号列表
media_info	Array		备份集发现/导入： （本地磁盘）存储单元路径； （磁带库）barcode清单
src_vp_name	String		（源）虚拟平台名称
src_vp_type	Number		（源）虚拟平台类型
src_vp_addr	String		（源）虚拟平台地址
src_region_name	String		（源）区域（云平台）
src_project_name	String		（源）项目（云平台）
src_vm_name	String		（源）备份对象（虚机名称）
tgt_vp_name	String		（目标）虚拟平台名称
tgt_vp_type	Number		（目标）虚拟平台类型
tgt_vp_addr	String		（目标）虚拟平台地址
tgt_region_name	String		（目标）区域（云平台）
tgt_project_name	String		（目标）项目（云平台）
tgt_vm_name	String		（目标）备份对象（虚机名称）
agent_node_name	String		代理客户端名称
hostname	String		目标主机名
disks	Array		磁盘列表
vm_priority	Number		虚机优先级
npsvr_name	String		管理服务器名称
status	String		状态	@pick('RUN', 'WAITING')
result	String		执行结果： SUCCESS、FAILED、STOP （未用到的字段）	@integer
state	String		状态码
start	Number		开始时间	123123131
end	Number		结束时间	234234234
bk_set_id	String		备份集ID
bk_set_info	Object		源备份集信息
dst_bk_set_info	Object		备份集复制：目标备份集信息

定时任务 - 操作

SDK方法名：重启：rebootBackupWork；停止：stopBackupWork；

URL

/backup_work/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
work_uuids	Array
operate	String		操作名称： 重启：reboot； 停止：stop；

Response

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

定时任务 - 删除

SDK方法名：deleteBackupWork;

URL

/backup_work

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
work_uuids	Array		任务uuid
force	Number		强制删除

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
success_list	Array
code	Number			0
message	String			[0] 操作成功。
work_uuid	String			80101418-24C2-4160-9308-C25B1682C41A
work_name	Null
all_list	Array
code	Number			0
message	String			[0] 操作成功。
work_uuid	String			80101418-24C2-4160-9308-C25B1682C41A
work_name	Null

定时任务 - 获取日志

SDK方法名：listBackupWorkLogs;

URL

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

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
level	Number		日志等级
start	Number		时间范围：开始时间，unix时间戳
end	Number		时间范围：结束时间，unix时间戳
search_content	String		模糊查询：关键字
type	Number		需要刷新的日志列表： 0：客户端； 1：备份服务器； 2：调度服务器； 3：第三方插件； 非必填，不传时，同时返回所有类型的列表
node_uuid	String		调度服务器节点uuid，当type=2时必传
page	Number		分页页数 单一列表分页参数，指定type时必传
limit	Number		分页条数 单一列表分页参数，指定type时必传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String			[0] 操作成功
list	Array		日志列表的列表		2
type	Number		日志类型： 0：客户端； 1：备份服务器； 2：调度服务器； 3：第三方插件；		0-3
node_uuid	String		客户端/备份服务器 UUID	@uuid
node_name	String		客户端/备份服务器 名称	node-@first
info_list	Array		日志列表		6-10
id	Number		主键ID	@increment
uuid	String		任务uuid	@uuid
log_level	Number		日志等级： 0：错误； 1：警告； 2：正常； 5：关键事件；		0-4
operation	String		操作	op-@word
detail	String		日志内容	@sentence
create_time	String		时间	@datetime
log_type	Number		日志类型（前缀，例如[wk]等）		0-10
total	Number		总条数		9-20
code	Number			0

定时任务 - 获取关键事件

SDK方法名：listBackupWorkKeyEvents;

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String			[0] 操作成功
code	Number			0
list	Array		关键事件，实际上就是log_level为NOTIFY的日志
id	Number			1
uuid	String
log_level	Number			1
operation	String
detail	String
create_time	String
log_type	Number			1
node_name	String

定时任务 - 查看任务结果

SDK方法名：describeBackupWorkResult;

URL

/backup_work/result

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
work_uuids	Array		任务uuid
op_switch	Number		开关：0-否 1是 出库根据需要弹窗显示时需要
barcode_list	Array		磁带介质操作界面查看任务结果 传入slot_barcode，防止获取任务结果失败，用于构造对应磁带的结果状态-unknown

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
code	Number			0
message	String			success
status	String		FINISH STOP FAILED
detail	Array
slot_barcode	String
slot_index	String
slot_flag	String
library_uuid	String
status	String		出库： - 出库中 （默认初始状态） 27 - 移动中(28) - 出库失败(29) - 移除磁带(30) - 移除成功(31) - 等待移除(32) 浏览： - 浏览成功(33) - 浏览失败(34) 重构： - 重构成功(35) - 重构失败(36) 入库： - 入库成功 37 - 入库失败 38 具体参考底层rpc: https://apiref.info2soft.com/organization/repository/editor?id=21&mod=470&itf=5731
code	String
pool_name	String
ieslot_index	String
change	String		new - 新增 outbound - 出库 renew - 重新入库
dialog_switch	Number		出库弹窗: 0 - 不弹出 1 - 弹窗
ret	Number			200
msg	String

------- 过滤器 -------

URL

/dash/backup_work_filter

Method

GET

Request

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

Response

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

过滤器 - 列表

SDK方法名：listBackupWorkFilter;

URL

/backup_work_filter

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String			[0] 操作成功
code	Number			0
list	Array				1-5
id	String
filter_uuid	String		过滤器uuid	@uuid
filter_name	String		过滤器名称	@first
description	String		说明	@sentence
and_or	Number		0：与； 1：或；		0-1

过滤器 - 新建

方法名：createBackupWorkFilter;

URL

/backup_work_filter

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
filter_name	String		过滤器名称
description	String		说明
and_or	Number		0：与； 1：或；
rules	Array
key	String		过滤字段
operator	String		比较符号
value	String		过滤值

Response

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

过滤器 - 详情

SDK方法名：describeBackupWorkFilter;

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
backup_work_filter	Object
id	String			@increment
filter_uuid	String		过滤器uuid	@uuid
filter_name	String		过滤器名称	@first
description	String		描述	@sentence
and_or	Number		0：与； 1：或；		0-1
rules	Array		过滤规则		2-5
key	String		过滤字段	@pick('rc_task_name', 'sched_name')
operator	String		比较符号	@pick(=, !=)
value	String		过滤值	@word
code	Number			0

过滤器 - 修改

SDK方法名：modifyBackupWorkFilter;

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
filter_name	String
description	String
and_or	Number
rules	Array
key	String
operator	String
value	String

Response

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

过滤器 - 删除

DK方法名：deleteBackupWorkFilter;

URL

/backup_work_filter

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
filter_uuids	Array
force	Number			0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 找不到节点
filter_uuid	String			@uuid
filter_name	String			@name
success_list	Array
code	Number			11110001
message	String			[0] success
filter_uuid	String			@uuid
filter_name	String			@name