大数据

SDK类名：/bigdata/Backup;

备份 - 新建

SDK类名：/bigdata/Backup;

SDK方法名：createBigdataBackup

URL

/bigdata/backup

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bigdata_backup	Object	否
rule_name	String	否	任务名称
rule_uuid	String	否
bk_uuid	String	否	灾备机uuid	F85DFEC0-149E-373D-0B9E-3DA9A5C43940
bk_path	Array	否	灾备机路径
baked_paths	Array	否	要备份的路径
data_type	String	否	数据类型 HIVE HDFS HBASE
cred_switch	Number	否	使用凭证开关
cred_uuid	String	否	凭证uuid
auth_user	String	否	用户
auth_key	String	否	凭证
mirr_file_check	Number	否	校验方式	0
mirr_sync_flag	Number	否	错误处理
bkup_one_time	Number	否	一次任务时间：参考云备份	0
bkup_policy	Number	否	策略类型：参考云备份	2
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
random_str	String	否		11111111-1111-1111-1111-111111111111
cluster_config_path	String		集群配置路径
tape_uuid	String			E8566905-411E-B2CD-A742-77B1346D8E84
archive_pen	Number		是否开启备份归档：0-否 1-是	0
library_sn	String		磁带序列号	SYZZY_A
tape_pool_uuid	String		磁带池uuid
tape_pool_name	String		磁带池名称
tape_name	String		磁带名
tape_reserve	Number		磁带保留： 0：按备份周期保留； 1：永久保留；
sel_db	Array	是	所选库的数组 按库时传值
sel_tbl	Array		所选表的数组 按表时传值
hive_bktype	Number		取值1: 按库 2: 按表
filter_type	Number		取值1：包含 2：排除
filter_files	String		包含或者排除的文件类型，以逗号分隔
exclude_paths	String		排除目录数组
band_width	String		带宽控制：12301:00-02:002m,3412:00-13:006m，按照此类型拼接，没有可不传
post_backup_script	String		前置脚本路径
pre_backup_script	String		后置脚本路径
script_timeout	Number		脚本超时时间
obs_settings	Object		对象存储配置信息
sto_uuid	String		对象存储uuid
bucket_name	String		对象桶（name）
bucket_path	String		桶路径

Response

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

备份 - 列表

SDK类名：/bigdata/Backup;

SDK方法名：listBigdataBackup

URL

/bigdata/backup

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
search_field	String	否	可选，搜索字段
search_value	String	否	可选，搜索字段对应值（可以模糊）
limit	Number	否	可选，不传就是全部	10
page	Number	否	可选，不传就是全部	1
type	Number	否	任务类型：备份任务：0； 还原任务：1；	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
ret	Number	否		200
data	Object	否
message	String	否		[0] success
code	Number	否		0
info_list	Array	否			2
rule_name	String	否		@first
data_type	String	否		HIVE
bk_node_name	String	否		node2
username	String	否		root
rule_type	Number	否		0
can_op	Number			1
can_up	Number			1
can_del	Number			1
rule_uuid	String			D552cCC1-B839-Ed3e-2DB0-58D8cBD9C876
total	Number	否		2

备份 - 状态

SDK类名：/bigdata/Backup;

SDK方法名：listBigdataBackupStatus

URL

/bigdata/backup/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
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	否
status	String	否		@pick(["ONLINE", "OFFLINE", "UNKNOWN", "ERR_TKN", "STOP"])
uuid	String	否		D552cCC1-B839-Ed3e-2DB0-58D8cBD9C876
progress	String	否		@integer(0,100)
remaining_time	String		剩余时间	@time(mm:ss)

备份 - 单个

SDK类名：/bigdata/Backup;

SDK方法名：describeBigdataBackup

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
bigdata_backup	Object	否
auth_key	String
auth_user	String
baked_paths	Array			["/drt/", "/mqysxbrl/"]
bk_path	String			test111
bk_uuid	String			47Dc9f4C-C0C4-b5d6-639B-c6FAfDcAC5b9
bkup_one_time	String			1603270334
bkup_policy	Number			1
bkup_schedule	Array
cluster_config_path	String			qgcov
cred_switch	Number			0
cred_uuid	String
data_type	String			HIVE
mirr_file_check	Number			0
mirr_sync_flag	Number			0
rule_name	String			123
rule_uuid	String			AFFFf31f-dcAD-74f2-0de8-eA10da79A581
tape_uuid	String			磁带库uuid
archive_pen	Number			1
library_sn	String			123
hive_bktype	Number			1
sel_db	Array			["aaa", "bbb"]

备份 - 操作

SDK类名：/bigdata/Backup;

SDK方法名：'operateBigdataBackup';

URL

/bigdata/backup/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	start | stop	start_immediately
uuids	Array	否		[C6335F62-2565-1957-4BB9-587F2FF46B00]
bk_type	Number		立即执行操作（start_immediately）必传，取值为，备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异

Response

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

备份 - 删除

SDK类名：/bigdata/Backup;

SDK方法名：deleteBigdataBackup

URL

/bigdata/backup

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	否		["11111111-1111-1111-1111-111111111111"]
del_policy	Number	否	0: 不删除 1： 删除	0

Response

名称	类型	必选	简介	Mock初始值	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
rule_uuid	String	否		4546EC34-FB30-911A-21E6-131415BB6417

========= 分界线 ==========

URL

/dash0

Method

GET

Request

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

Response

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

还原 - 准备 - 获取备份列表

SDK类名：/bigdata/Recovery;

SDK方法名：listBackupHistory

URL

/bigdata/recovery/bak_history

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_path	Array	否	说明： 使用备份数据目录的值
bk_node_uuid	String	否	说明： 备机uuid
bk_rule_uuid	String	否	备份规则uuid
cluster_config_path	String		备份配置文件路径
obs_settings	Object
sto_uuid	String		对象存储uuid
bucket	String		桶名称
bk_type	String		0：文件系统，1：对象存储

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
backup_rule	Object
bk_path	String			ecmbuwfih/
rule_uuid	String			@uuid
data_type	String
recovery_rule	Object
time_list	Array
2020-11-27_10-01-28	Object
bak_type	Array			["i",null]	+1
path	Array				2
bk_path	Array			["D:\bakrootpathxxx\A44B80C1-5067-1BAE-1355-A507B6B4E072\2020-11-27_10-01-28\iii\","D:\bakrootpathxxx\A44B80C1-5067-1BAE-1355-A507B6B4E072\2020-11-27_10-01-28\jjj\"]	+1
rc_path	Array			["\iii\","\jjj\"]	+1
sel_db	Array		所选表的数组 按表时传值
test_db1	Object
sel_tbl	Array				5
location	String		路径	@first
table_name	String		表名	@last
test_db2	Object
sel_tbl	Array				2
location	String			@first
table_name	String			@last
2020-11-27_11-11-11	Object
bak_type	String			o
path	Array				2
bk_path	Array			["D:\bakrootpathxxx\A44B80C1-5067-1BAE-1355-A507B6B4E072\2020-11-27_11-11-11\input\","D:\bakrootpathxxx\A44B80C1-5067-1BAE-1355-A507B6B4E072\2020-11-27_11-11-11\szq\"]	+1
rc_path	Array			["\input\","\szq\"]	+1
code	String			0
src_type	String			HBASE
cluster_config_path	String			D:\cluster\
wm_ip	String			192.168.32.2
hive_bktype	Number		取值1: 按库 2: 按表	2
code	Number			0
message	String			[0] success

还原 - 新建

SDK类名：/bigdata/Recovery;

SDK方法名：createBigdataRecovery

URL

/bigdata/recovery

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bigdata_recovery	Object	否
rule_name	String	否
rule_uuid	String	否
bk_uuid	String	否		F85DFEC0-149E-373D-0B9E-3DA9A5C43940
bk_path	Array	否		备份数据目录
baked_paths	Array	否		要恢复的目录
rc_data_path	Array	否		目标平台目录
rc_point	String	否		还原时间点
data_type	String	否
cred_switch	String	否
cred_uuid	String	否
auth_user	String	否
auth_key	String	否
mirr_file_check	String	否		0
mirr_sync_flag	String	否
cluster_config_path	String
sel_db	Array		所选库的数组 按库时传值
sel_tbl	Array		所选表的数组 按表时传值
hive_bktype	Number		取值1: 按库 2: 按表
rc_path_policy	String		恢复任务 路径映射类型： 0：一对一； 1：多对一；
obs_settings	Object
sto_uuid	String		对象存储uuid
bucket	String		对象桶（name）
bucket_path	String		桶路径

Response

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

还原 - 单个

SDK类名：/bigdata/Recovery;

SDK方法名：describeBigdataRecovery

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
total	Number	否		1
message	String	否
bigdata_recovery	Object	否
rule_name	String	否		123
rule_uuid	String	否		AFFFf31f-dcAD-74f2-0de8-eA10da79A581
bk_uuid	String	否		F85DFEC0-149E-373D-0B9E-3DA9A5C43940
bk_path	Array	否		["luyn\qbphsrr"]
baked_paths	Array	否		["/drt/", "/mqysxbrl/"]
rc_data_path	String	否		["test1", "test2"]
rc_point	String	否		2020-03-01_14-35-19
data_type	String	否		HIVE
cred_switch	Number	否		0
cred_uuid	String	否
auth_user	String	否
auth_key	String	否
mirr_file_check	Number	否		0
mirr_sync_flag	Number	否		0
bk_rule_uuid	String	否		F85DFEC0-149E-373D-0B9E-3DA9A5C43944
random_str	String	否		11111111-1111-1111-1111-111111111111

还原 - 删除

SDK类名：/bigdata/Recovery;

SDK方法名：deleteBigdataRecovery

URL

/bigdata/recovery

Method

DELETE

Request

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

Response

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

还原 - 列表

SDK类名：/bigdata/Recovery;

SDK方法名：listBigdataRecovery

URL

/bigdata/recovery

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
search_field	String	否
limit	Number	否		10
page	Number	否		1
search_value	String	否
type	Number	否		0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
ret	Number	否		200
data	Object	否
message	String	否		[0] success
code	Number	否		0
total	Number	否		2
info_list	Array	否
rule_name	String	否		bd_bk1
data_type	String	否		hadoop
bk_node_name	String	否		node1
username	String	否		root
rule_type	Number	否		0
can_op	Number			1
can_up	Number			1
can_del	Number			1
rule_uuid	String			38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1

还原 - 状态

SDK类名：/bigdata/Recovery;

SDK方法名：listBigdataRecoveryStatus

URL

/bigdata/recovery/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
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	否
status	String	否		@pick(["ONLINE", "OFFLINE", "NUKNOWN", "ERR_TKN"])
rule_uuid	String	否		@guid
remainingTime	String		剩余时间	00:06

还原 - 操作

SDK类名：/bigdata/Recovery;

SDK方法名：'operateBigdataRecovery'

URL

/bigdata/recovery/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否
uuids	String	否		[C6335F62-2565-1957-4BB9-587F2FF46B00]

Response

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

大数据平台 - 认证

SDK类名：/bigdata/Recovery;

SDK方法名：authBigdataPlatform

URL

/bigdata/backup/auth

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cred_uuid	String	否
auth_key	String	否
auth_name	String	否
bk_uuid	String	否

Response

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

条件获取hive数据库表名

SDK类名：/bigdata/Recovery;

SDK方法名：listBigdataHiveTable;

URL

/bigdata/backup/hive_table_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String		目标节点UUID	@guid
db_name	String		数据库名称
table_name	String		数据库表名称
limit	String		分页大小
page	String		当前分页号码
cluster_config_path	String		配置文件路径

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
total	Number		匹配条目总数	10
page_count	Number		匹配分页总数
limit	Number		分页大小	3
page	Number		当前分页号码	1
lists	Array		数据库表名	["tb1","tb2", "tb4", "tb3", "tb5","tb6","tb7","tb8"]
code	Number			0

获取所有数据库

SDK类名：/bigdata/Recovery;

SDK方法名：listAllBigdataHiveDatabase;

URL

/bigdata/backup/all_hive_database

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String			@guid
cluster_config_path	String		集群路径

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
message	String
data	Object
code	Number			0
message	String
hive_all_db	Array		所有数据库名列表	["aaa", "bbb", "ccc"]

大数据 - 获取hive表详细信息

获取表详细信息：getTableInfoDetail

URL

/bigdata/recovery/table_info_detail

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cluster_config_path	String		集群配置目录
back_path	String		备份数据目录
rec_time	String		还原时间点
table_name	String		表名
obs_settings	Object		对象存储配置信息（格式待定）
sto_uuid	String		对象存储uuid
bucket_name	String		对象桶（name）
bucket_path	String		桶路径
bk_type	String		0：文件系统 1：对象存储
bk_uuid	String		灾备机uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Object
message	String			success
code	String			0
table_info	Object
databases	String			@first
owner	String			@last
create_time	String			@datetime('yyyy-MM-dd A HH:mm:ss')
last_access_success	String			@string
location	String			@string
table_type	String			@natural(0, 3)
num_files	String			@natural(100, 10000)
num_rows	String			@natural(100, 10000)
raw_data_size	String			@natural(100, 10000)
total_data_size	String			@natural(100, 10000)
col_info	Array				10
col_name	String			@word
data_type	String			@pick(["text", "integer", "varchar", "datetime"])
comment	String			@string('upper', 5)
partition_info	Array				3
col_name	String			@word
data_type	String			@pick(["text", "integer", "varchar", "datetime"])
comment	String			@string('upper', 5)

大数据 - 测试链接

集群连接状态测试：testClusterConnection

URL

/bigdata/backup/cluster_check

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String		灾备机uuid
data_type	String		备份类型 hdfs hive
cluster_config_path	String		灾备机大数据配置文件路径

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String			200
msg	String			success
data	Object
code	String		不为0则失败	0
messgae	String		测试链接失败	测试成功
hdfs_url	String			hdfs://172.20.50.30:8020
hive_url	String			jdbc:hive2://192.168.48.201:10000