备份集发现

August 1, 2024About 6 min

备份集发现

SDK类名:/backupSet/BackupSetImport;

备份集发现 - 新建

URL

/backup_set_scan

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
task_nameString规则名
disableNumber规则禁用:
0:关;
1:开;
storage_unit_typeNumber存储单元类型
unit_uuidString存储单元(组)uuid
barcodeString(存储单元为磁带库时)条形码
task_search_typeString任务类型:0:仅发现,1:自动导入
biz_grp_listArray业务组uuid列表
bkup_policyNumber备份策略,2:立即执行,0:一次性,1:周期;

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。

备份集发现 - 修改

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
task_nameString规则名
disableNumber规则禁用:
0:关;
1:开;
storage_unit_typeString存储单元类型
unit_uuidString存储单元(组)uuid
barcodeString(存储单元为磁带库时)条形码
task_search_typeString任务类型:0:仅发现,1:自动导入
biz_grp_listArray业务组uuid列表

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。

备份集发现 - 单条查看

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
messageString[0] 操作成功。
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  backup_set_scanObject
    task_nameString
    disableNumber1
    storage_unit_typeString
    unit_uuidString
    barcodeString
    task_search_typeString
    biz_grp_listArray
  totalNumber1

备份集发现 - 状态

URL

/backup_set_scan/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
task_uuidsArray
force_refreshNumber强制刷新,0:关,1:开

Response

名称类型必选简介Mock初始值Mock规则
retNumber
msgString
dataObject
  codeNumber
  messageString
  statusArray
    task_uuidString
    statusStringDISABLE:禁用;
FINISH:完成;
UNKNOWN:未知;

备份集发现 - 操作

URL

/backup_set_scan/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
task_uuidsArray规则uuid数组
operateStringenable:启用;
disable:禁用;
manual_start:手动执行;

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。

备份集发现 - 列表

URL

/backup_set_scan

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    task_nameString
    disableNumber1
    storage_unit_typeString
    unit_uuidString
    barcodeString
    task_search_typeString
    biz_grp_listArray
    stateObject
      statusString
      last_startString上次开始
      last_durationString上次消耗时间
      backup_set_sumNumber发现备份集数量
  totalNumber1

备份集发现 - 删除

URL

/backup_set_scan

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
task_uuidsString发现规则uuids

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1055554016
  messageString[1055554016] 节点离线,通常为iahelper程序异常
  fail_listArray
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    bk_set_idString
  all_listArray
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    bk_set_idString
  success_listArray
    codeNumber0
    messageString
    bk_set_idString

备份集发现 - 已发现备份集列表

URL

/backup_set_scan/discovered_list

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
where_argsObject
  job_uuidString从备份任务查看结果
  origin_expire_time_startNumber原删除时间大于
  origin_expire_time_endNumber原删除时间小于
  bk_start_tmNumber备份时间范围大于
  bk_end_tmNumber备份时间范围小于

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    job_uuidString
    bk_set_uuidString
    origin_expire_timeString原过期时间
    bk_set_idStringlinux-xnwg_1713726018_2FD9D93F_1
    bk_rule_uuidString17D946C1-82A6-4433-AA0F-AF7C8744D4C6
    copy_idNumber1
    wk_uuidString
    wk_node_nameString
    wk_host_nameString
    wk_host_addrString
    bk_rule_nameString
    bk_typeString
    storage_mediaString
    barcodeString
    unit_uuidString
    storage_unit_nameString
    storage_unit_typeString
    bk_filesString
    bk_sizeString
  totalNumber1

备份集导入 - 导入

URL

/backup_set_scan/import

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
bk_set_uuidsString选中导入备份集记录

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1055554016
  messageString[1055554016] 节点离线,通常为iahelper程序异常
  fail_listArray
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    bk_set_idString
  all_listArray
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    bk_set_idString
  success_listArray
    codeNumber0
    messageString
    bk_set_idString

备份集导入 - 删除待导入备份集

URL

/backup_set_scan/delete_backup_set

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
bk_set_uuidsString选中导入备份集记录

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1055554016
  messageString[1055554016] 节点离线,通常为iahelper程序异常
  fail_listArray
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    bk_set_idString
  all_listArray
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    bk_set_idString
  success_listArray
    codeNumber0
    messageString
    bk_set_idString

备份集发现 - 规则搜索备选项

URL

/backup_set_scan/query_args

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
search_fieldString搜索字段名(仅限可以条件查询的),目前支持storage_unit_name,task_namestorage_unit_name
search_valueString搜索内容

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalString
  info_listArray对应模糊搜索结果(根据系统设置分页)

备份集发现 - 发现结果 搜索备选项

URL

/backup_set_scan/bk_set_query_args

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
search_fieldString搜索字段名(仅限可以条件查询的),支持字段:wk_node_name,bk_rule_name,storage_unit_name
search_valueString搜索内容

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalString
  info_listArray对应模糊搜索结果(根据系统设置分页)
Last update: 8/1/2024, 2:00:50 PM
Contributors: ganl