webapi-BigData

November 23, 2021About 10 min

webapi-BigData

SDK类名:/bigdata/Backup;

备份 - 新建

SDK类名:/bigdata/Backup;

SDK方法名:createBigdataBackup

URL

//bigdata/backup

Method

POST

Request

名称类型必选初始值简介Mock规则
bigdata_backupObject
  rule_nameString任务名称
  rule_uuidString
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940灾备机uuid
  bk_pathArray灾备机路径
  baked_pathsArray要备份的路径
  data_typeString数据类型 HIVE HDFS HBASE
  cred_switchNumber使用凭证开关
  cred_uuidString凭证uuid
  auth_userString用户
  auth_keyString凭证
  mirr_file_checkNumber0校验方式
  mirr_sync_flagNumber错误处理
  bkup_one_timeNumber0一次任务时间:参考云备份
  bkup_policyNumber2策略类型:参考云备份
  bkup_scheduleArray备份策略:参考云备份
    sched_dayString@integer(1, 31)
    sched_timeString@time('HH:mm')
    sched_everyNumber2
    limitString@integer(1, 64)
    backup_typeNumber0
    policysString每天22:00自动执行
    backup_type_showString全备
    running_timeString22:00
  random_strString11111111-1111-1111-1111-111111111111
  cluster_config_pathString集群配置路径
  tape_uuidStringE8566905-411E-B2CD-A742-77B1346D8E84
  archive_penString0
  library_snStringSYZZY_A
  sel_dbArray所选库的数组 按库时传值
  sel_tblArray所选表的数组 按表时传值
  hive_bktypeNumber取值1: 按库 2: 按表

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success

备份 - 列表

SDK类名:/bigdata/Backup;

SDK方法名:listBigdataBackup

URL

//bigdata/backup

Method

GET

Request

名称类型必选初始值简介Mock规则
search_fieldString可选,搜索字段
search_valueString可选,搜索字段对应值(可以模糊)
limitNumber10可选,不传就是全部
pageNumber1可选,不传就是全部
typeNumber0任务类型:备份任务:0;
还原任务:1;

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  messageString[0] success
  codeNumber0
  info_listArray2
    rule_nameString@first
    data_typeStringHIVE
    bk_node_nameStringnode2
    usernameStringroot
    rule_typeNumber0
    can_opNumber1
    can_upNumber1
    can_delNumber1
    rule_uuidStringD552cCC1-B839-Ed3e-2DB0-58D8cBD9C876
  totalNumber2

备份 - 状态

SDK类名:/bigdata/Backup;

SDK方法名:listBigdataBackupStatus

URL

//bigdata/backup/status

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  statusArray
    statusString@pick(["ONLINE", "OFFLINE", "UNKNOWN", "ERR_TKN"])
    uuidStringD552cCC1-B839-Ed3e-2DB0-58D8cBD9C876
    progressString@integer(0,100)
    remaining_timeString@time(mm:ss)剩余时间

备份 - 单个

SDK类名:/bigdata/Backup;

SDK方法名:describeBigdataBackup

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  bigdata_backupObject
    auth_keyString
    auth_userString
    baked_pathsArray["/drt/", "/mqysxbrl/"]
    bk_pathStringtest111
    bk_uuidString47Dc9f4C-C0C4-b5d6-639B-c6FAfDcAC5b9
    bkup_one_timeString1603270334
    bkup_policyNumber1
    bkup_scheduleArray
    cluster_config_pathStringqgcov
    cred_switchNumber0
    cred_uuidString
    data_typeStringHIVE
    mirr_file_checkNumber0
    mirr_sync_flagNumber0
    rule_nameString123
    rule_uuidStringAFFFf31f-dcAD-74f2-0de8-eA10da79A581
    tape_uuidString磁带库uuid
    archive_penNumber1
    library_snString123

备份 - 操作

SDK类名:/bigdata/Backup;

SDK方法名:'operateBigdataBackup';

URL

//bigdata/backup/operate

Method

POST

Request

名称类型必选初始值简介Mock规则
operateStringstart | stopstart_immediately
uuidsArray[C6335F62-2565-1957-4BB9-587F2FF46B00]
bk_typeNumber立即执行操作(start_immediately)必传,取值为,备份策略 - 周期任务 - 备份方式;0:全备,1:增量,2:差异

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0

备份 - 删除

SDK类名:/bigdata/Backup;

SDK方法名:deleteBigdataBackup

URL

//bigdata/backup

Method

DELETE

Request

名称类型必选初始值简介Mock规则
uuidsArray["11111111-1111-1111-1111-111111111111"]
del_policyNumber00: 不删除
1: 删除

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  success_listArray
    codeNumber0
    messageString[0] success
    rule_uuidString4546EC34-FB30-911A-21E6-131415BB6417

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

URL

/dash0

Method

GET

Request

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

Response

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

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

SDK类名:/bigdata/Recovery;

SDK方法名:listBackupHistory

URL

//bigdata/recovery/bak_history

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_pathArray说明: 使用备份数据目录的值
bk_node_uuidString说明: 备机uuid
bk_rule_uuidString备份规则uuid

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  backup_ruleObject
    bk_pathStringecmbuwfih/
    rule_uuidString@uuid
    data_typeString
  recovery_ruleObject
    time_listArray2
      2020-11-27_10-01-28Object
        bak_typeArray["i",null]+1
        pathArray2
          bk_pathArray["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_pathArray["\iii\","\jjj\"]+1
      2020-11-27_11-11-11Object
        bak_typeStringo
        pathArray2
          bk_pathArray["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_pathArray["\input\","\szq\"]+1
    codeString0
    src_typeStringHBASE
    cluster_config_pathStringD:\cluster\
    wm_ipString192.168.32.2
    hive_bktypeNumber1取值1: 按库 2: 按表
    sel_dbArray["default", "hive_jdbc_test"]所选库的数组 按库时传值
    sel_tblArray[{
"table_name": "default.emp",
"location": "/user/hive/warehouse/emp/"
}, {
"table_name": "default.student",
"location": "/user/hive/warehouse/student/"
}, {
"table_name": "default.studentext",
"location": "/studata/"
}, {
"table_name": "hive_jdbc_test.farmer",
"location": "/home/hadoop/hive/warehouse/farmer/"
}]
所选表的数组 按表时传值
      table_nameStringdefault.studentex表名
      locationString/user/hive/warehouse/student/恢复路径
  codeNumber0
  messageString[0] success

还原 - 新建

SDK类名:/bigdata/Recovery;

SDK方法名:createBigdataRecovery

URL

//bigdata/recovery

Method

POST

Request

名称类型必选初始值简介Mock规则
bigdata_recoveryObject
  rule_nameString
  rule_uuidString
  bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940
  bk_pathArray备份数据目录
  baked_pathsArray要恢复的目录
  rc_data_pathArray目标平台目录
  rc_pointString还原时间点
  data_typeString
  cred_switchString
  cred_uuidString
  auth_userString
  auth_keyString
  mirr_file_checkString0
  mirr_sync_flagString
  cluster_config_pathString
  sel_dbArray所选库的数组 按库时传值
  sel_tblArray所选表的数组 按表时传值
  hive_bktypeNumber取值1: 按库 2: 按表

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString[0] success

还原 - 单个

SDK类名:/bigdata/Recovery;

SDK方法名:describeBigdataRecovery

URL

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

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalNumber1
  messageString
  bigdata_recoveryObject
    rule_nameString123
    rule_uuidStringAFFFf31f-dcAD-74f2-0de8-eA10da79A581
    bk_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43940
    bk_pathArray["luyn\qbphsrr"]
    baked_pathsArray["/drt/", "/mqysxbrl/"]
    rc_data_pathString["test1", "test2"]
    rc_pointString2020-03-01_14-35-19
    data_typeStringHIVE
    cred_switchNumber0
    cred_uuidString
    auth_userString
    auth_keyString
    mirr_file_checkNumber0
    mirr_sync_flagNumber0
    bk_rule_uuidStringF85DFEC0-149E-373D-0B9E-3DA9A5C43944
    random_strString11111111-1111-1111-1111-111111111111

还原 - 删除

SDK类名:/bigdata/Recovery;

SDK方法名:deleteBigdataRecovery

URL

//bigdata/recovery

Method

DELETE

Request

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

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString[0] success

还原 - 列表

SDK类名:/bigdata/Recovery;

SDK方法名:listBigdataRecovery

URL

//bigdata/recovery

Method

GET

Request

名称类型必选初始值简介Mock规则
search_fieldString
limitNumber10
pageNumber1
search_valueString
typeNumber0

Response

名称类型必选初始值简介Mock规则
msgString
retNumber200
dataObject
  messageString[0] success
  codeNumber0
  totalNumber2
  info_listArray
    rule_nameStringbd_bk1
    data_typeStringhadoop
    bk_node_nameStringnode1
    usernameStringroot
    rule_typeNumber0
    can_opNumber1
    can_upNumber1
    can_delNumber1
    rule_uuidString38FFA6E2-2A40-31D6-7A94-E8168EBA9FF1

还原 - 状态

SDK类名:/bigdata/Recovery;

SDK方法名:listBigdataRecoveryStatus

URL

//bigdata/recovery/status

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  statusArray
    statusString@pick(["ONLINE", "OFFLINE", "NUKNOWN", "ERR_TKN"])
    rule_uuidString@guid
    remainingTimeString00:06剩余时间

还原 - 操作

SDK类名:/bigdata/Recovery;

SDK方法名:'operateBigdataRecovery'

URL

//bigdata/recovery/operate

Method

POST

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0

大数据平台 - 认证

SDK类名:/bigdata/Recovery;

SDK方法名:authBigdataPlatform

URL

//bigdata/backup/auth

Method

POST

Request

名称类型必选初始值简介Mock规则
cred_uuidString
auth_keyString
auth_nameString
bk_uuidString

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0

条件获取hive数据库表名

URL

//bigdata/backup/hive_table_list

Method

GET

Request

名称类型必选初始值简介Mock规则
bk_uuidString@guid目标节点UUID
db_nameString数据库名称
table_nameString数据库表名称
limitString分页大小
pageString当前分页号码

Response

名称类型必选初始值简介Mock规则
retNumber200
msgString
dataObject
  totalNumber10匹配条目总数
  page_countNumber匹配分页总数
  limitNumber3分页大小
  pageNumber1当前分页号码
  listsArray["tb1","tb2", "tb4", "tb3", "tb5","tb6","tb7","tb8"]数据库表名
  codeNumber0

获取所有数据库

URL

//bigdata/backup/all_hive_database

Method

GET

Request

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

Response

名称类型必选初始值简介Mock规则
retNumber200
messageString
dataObject
  codeNumber0
  messageString
  hive_all_dbArray["aaa", "bbb", "ccc"]所有数据库名列表
Last update: 6/25/2022, 9:23:18 PM
Contributors: ganl