磁带管理

February 26, 2024About 17 min

磁带管理

SDK类名:/resource/Tape;

示例接口

示例接口描述

URL

/example/1691976311143

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
fooString请求属性示例@ctitle

Response

名称类型必选简介Mock初始值Mock规则
stringString字符串属性示例1-10
numberNumber数字属性示例11-100
booleanBoolean布尔属性示例true1-2
regexpRegExp正则属性示例/[a-z][A-Z][0-9]/
functionFunction函数属性示例() => Math.random()
arrayArray数组属性示例1-10
  fooNumber数组元素示例1+1
  barString数组元素示例1-10
itemsArray自定义数组元素示例[1, true, 'hello', /\w{10}/]
objectObject对象属性示例
  fooNumber对象属性示例1+1
  barString对象属性示例1-10
placeholderString占位符示例@title

磁带库 - 扫描

SDK方法名:sanTapeLibraries;

URL

/tape_library/scan

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
bk_uuidsArray备份服务器名称

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  library_info|4Array
    checkedBoolean
    bk_uuidString备份服务器uuidD42BF707-C971-EEA9-521F-BB0F3F7A92FC
    bk_node_nameString备份服务器名称备份服务器1
    library_snString序列号SYZZ_A
    library_vendorString厂商STK
    library_productString带库型号L80
    library_revisionString产品版本0106
    dev_pathString设备路径/dev
    drive_numNumber驱动器数1
    slot_numNumber槽数1
    addedNumber是否已被添加过
0否1是
    library_uuidString已添加带库uuid

磁带库 - 获取带库驱动器列表

SDK方法名:listTapeLibraryDrivers;

URL

/tape_library/drivers

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
listArray【可选】配置驱动器时调用
  bk_uuidString
  library_snString
library_uuidString【可选】带库列表点击驱动器管理时调用

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  library_nameString带库名称
  ctrl_host_nameString控制主机名称
  info_list|2Array
    bk_uuidString带库对应节点
    bk_node_nameString
    library_snString带库序列号DDQQ
    driver_list|2Array从带库对应节点上面获取到的驱动信息
      checkedBoolean
      indexString1
      barcodeString磁带 空显示EMPTYDDAA
      driver_snString
      dev_pathStringpath_more
      statusString1 - ACTIVE, 已用
2 - UP, 空闲
3 - MANU_DOWN 禁用(手动)
4 - AUTO_DOWN 禁用(系统)
      last_writeString
      time_errorString
      use_hostString当前使用主机admin

磁带库 - 新建

SDK方法名:createTapeLibrary;

URL

/tape_library

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
library_nameString磁带带库名(逻辑上的)磁带库1
commentString说明说明
bk_uuid_listArray备份服务器 这里下发的是带库所在的备机列表["D42BF707-C971-EEA9-521F-BB0F3F7A92FC"]
ctrl_host_uuidString控制机主机uuid
library_snString控制机主机关联带库 序列号
library_vendorString控制机主机关联带库 厂商
library_productString控制机主机关联带库 产品型号
library_revisionString控制机主机关联带库 产品版本
drive_numString控制机主机关联带库 驱动器数
slot_numString控制机主机关联带库 槽数
dev_pathString控制机主机关联带库 设备路径
library_listArray带库列表 带库与节点的关系是一对多
  checkedBoolean是否选为控制主机 - false否true是
  bk_uuidString备份服务器uuid'D42BF707-C971-EEA9-521F-BB0F3F7A92FC'
  library_snString序列号SYZZ_A
  library_vendorString厂商STK
  library_productString产品型号L80
  library_revisionString产品版本0106
  drive_numNumber驱动器数1
  slot_numNumber槽数1
  dev_pathString设备路径/dev
driver_infoArray
  bk_uuidString
  library_snString
  driver_listArray配置驱动器的配置信息 对应的是否选择 0否1是
    checkedString是否勾选
    indexString
    barcodeString
    driver_snString
    dev_pathString
    statusString
    last_writeString
robotic_arm_infoArray机械臂主机列表信息
slaveNumber0 - 下发到控制主机、机械臂主机、从机
1 - 只下发到从机

Response

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

磁带库 - 列表

SDK方法名:listTapeLibrary;

URL

/tape_library

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  countNumber10
  info_listArray
    ctrl_host_uuidString@uuid
    ctrl_host_nameString控制机主机名
    library_nameString磁带库名
    library_uuidString一个uuid对应多个库 一对多磁带库uuid
    library_snString@string
    library_vendorStringSTK
    library_revisionString@int(100, 10000)
    drive_numNumber1
    slot_numNumber1
  totalNumber1
  codeNumber0
  messageString
msgString
retNumber200

磁带库 - 单个

SDK方法名:describeTapeLibrary;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  tape_libraryObject
    library_nameString磁带库1
    library_uuidString
    commentString说明
    bk_uuid_listArray["D42BF707-C971-EEA9-521F-BB0F3F7A92FC"]
    random_strString
    library_listArray
      ctrl_hostNumber1
      node_uuidString'D42BF707-C971-EEA9-521F-BB0F3F7A92FC'
      library_snStringSYZZ_A
      library_vendorStringSTK
      library_productStringL80
      library_revisionString0106
      drive_numNumber1
      slot_numNumber1
      dev_pathString/dev
    user_uuidString
  codeNumber0

磁带库 - 修改

SDK方法名:modifyTapeLibrary;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
library_nameString磁带库1
library_uuidString
random_strString
commentString说明
bk_uuid_listArray["D42BF707-C971-EEA9-521F-BB0F3F7A92FC"]
curl_host_uuidString
library_snString
library_vendorString
library_productString
drive_numString
library_revisionString
dev_pathString
slot_numString
library_listArray
  checkedNumber
  bk_uuidString'D42BF707-C971-EEA9-521F-BB0F3F7A92FC'true
  library_snStringSYZZ_A
  library_vendorStringSTK
  library_productStringL80
  library_revisionString0106
  drive_numNumber1
  slot_numNumber1
  dev_pathString/dev
driver_infoArray
  bk_uuidString
  library_snString
  driver_listObject
    checkedString
    indexString
    barcodeString
    driver_snString
    statusString
    dev_pathString
    last_writeString

Response

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

磁带库 - 删除

SDK方法名:deleteTapeLibrary;

URL

/tape_library

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
library_uuidsArray带库uuid列表
forceNumber是否强制删除 0否1是

Response

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

磁带库 - 清点 - 刷新

SDK方法名:refreshTapeLibrarySlot;

URL

/tape_library/refresh_slot

Method

POST

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  task_uuidString刷新任务uuid
  messageString[0] 操作成功
  codeNumber0

磁带库 - 清点 - 扫描插槽(废弃)

SDK方法名:scanSlot;

URL

/tape_library/scan_slot

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  slots_info|3Array
    slot_indexString1
    slot_barcodeStringxxxx

磁带库 - 出库 - 获取Slot

SDK方法名:listBusySlot;

URL

/tape_library/busy_slot

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  slots_busy_infoArray
    indexString
    barcodeString

磁带库 - 入库 - 扫描I/O插槽

SDK方法名:listBusyIeSlot;

URL

/tape_library/busy_ie_slot

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  ieslots_busy_infoArray
    indexString
    barcodeString

磁带库 - 操作

SDK方法名:operateTapeLibrary;

URL

/tape_library/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringimport - 入库-移动磁带到插槽
library_uuidsArray带库uuid
listArray【可选】入库 - 移动磁带到插槽时用
  ieslot_indexStringieslot
  ieslot_barcodeStringieslot

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  slot_indexArray入库-移动到插槽后返回,界面依次显示到插槽列

磁带库 - 驱动器管理 - 操作

SDK方法名:operateTapeLibraryDrivers;

URL

/tape_library/drivers_operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringenable - 启用禁用
move - 装载卸载
library_uuidString带库uuid
driver_indexString驱动器索引
slot_indexString【可选】磁带索引 装载卸载必选
slot_flagString【可选】磁带状态 装载卸载必选
statusString【必传】驱动器状态
driver_snString【可选】驱动器序列号 启用禁用必选
dev_pathString【可选】设备路径 启用禁用必选
barcodeString【可选】Empty表示装载,其他表示卸载
tape_uuidString【可选】磁带uuid 装载需要

Response

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

介质 - 磁带池列表

SDK方法名:listTapePools;

URL

/tape_media/tape_pools

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  pool_list|3Array
    pool_nameString
    commentString
    noteStringname
    pool_uuidStringE95CB20B-917C-57F4-F926-751ECE95F861
    random_strString
  codeNumber0
  messageStringsuccess

介质 - 磁带池 - 新建

SDK方法名:createTapePool;

URL

/tape_media/tape_pool

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
pool_nameString磁带池名 rpc下发用 不可修改
commentString可修改
noteString备注,可修改,界面展示用 类似微信用户备注

Response

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

介质 - 磁带池 - 修改

SDK方法名:updateTapePool;

URL

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

Method

PUT

Request

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

Response

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

介质 - 磁带池 - 删除

SDK方法名:deleteTapePool;

URL

/tape_media/tape_pool

Method

DELETE

Request

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

Response

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

介质 - 磁带 - 操作

SDK方法名:operateTapeMedia;

URL

/tape_media/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
listArray
  library_uuidString带库uuid
  slot_indexString插槽index
  slot_barcodeString磁带序列号
  slot_tapenameString【可选】重构需要
  slot_tapesequenceString【可选】重构需要
  pool_nameString【可选】重构需要
freezeString0是解冻,1是冻结
operateStringfreeze - 冻结/解冻
browse - 浏览
rebuild - 重构
export - 出库
move - 移动
refresh - 更新介质
format - 格式化 - 不支持
erase - 擦除
src_pool_nameString【可选】移动时必传 源磁带池名
dst_pool_nameString【可选】移动时必传 目标磁带池名
backupset_infoArray擦除所需参数,定义参考接口:https://apiref.info2soft.com/organization/repository/editor?id=21&mod=470&itf=5593
  copy_idNumber
  bk_set_idString
  stageNumber

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  task_uuidsArray异步任务uuid,根据该uuid查询异步任务结果状态,状态完成后调用task_

介质 - 磁带 - 列表

SDK方法名:listTapeMedia;

URL

/tape_media

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
where_args[library_uuid]String根据带库过滤
where_args[pool_name]String根据磁带池名过滤
where_args[outbound]Number1表示已出库过滤
where_args[slot_tapename]String按磁带组名过滤
like_args[bk_rule_name]String备份集过滤,多个逗号隔开
like_args[slot_barcode]String按条形码过滤 多个逗号割开
where_args[slot_flag]String状态过滤:

装载 - 获取磁带列表:
BLANK - 可用
ACTIVE - 存在数据
FULL - 满

卸载 - 获取磁带列表:
EMPTY - 没有磁带
【无法调度的状态】 UNKNOWN_DATA ACTIVE FULL
typeNumber【可选】 点击刷新按钮时必选,其他不传
0-获取全部磁带信息
1-获取有效磁带信息
2-获取自由磁带信息
flagNumber【可选】 点击刷新按钮时必选,其他不传
筛选磁带状态
0-不筛选
1-只获取KNOWN状态的磁带
2-只获取BLANK状态的磁带
3-只获取UNKNOWN状态的磁带
content_initString【可选】入库初始状态-BLANK 无法调度的磁带

Response

名称类型必选简介Mock初始值Mock规则
dataObject
  countNumber10
  info_list|2Array
    library_nameString磁带库名称磁带库名称1
    library_uuidString磁带库uuid0B2421D6-C6C1-C3C1-ECEF-C484B69C6878
    slot_indexString索引1
    slot_flagString状态
OUTBOUND - 已出库
底层接口:
https://apiref.info2soft.com/organization/repository/editor?id=21&mod=470&itf=6230
    slot_barcodeString条形码xxxx
    slot_tapenameString磁带名磁带名1
    slot_tapesequenceString组内序号12345
    slot_mtypeString型号
    dst_typeString归档目标类型
    pool_nameString磁带池名称磁带池名称1
    user_uuidString
    statusString状态
冻结 - 界面显示冻结 0否1是
返回1显示冻结,返回0则显示slot_flag对应的状态
0
    write_protectedNumber是否开启写保护
0 - 否
1 - 是
    slot_expiretimeNumber过期时间1706255405
  totalNumber1
  codeNumber0
  messageString
msgString
retNumber200

查看磁带

SDK方法名:listTapeMediaBkData;

URL

/tape_media/bkdata

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
slot_barcodeString磁带条形码
limitString页大小;默认打开时15页
pageString页号
begin_timeString开始时间
end_timeString结束时间;两个时间有一个为空就不筛选
check_ruleNumber【预留】是否检查规则
0 - 不检查 【磁带库跳转】
1 - 检查【规则跳转】
task_uuidString【预留】备份任务uuid

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageString
  info_listArray
    slot_listArraysession所在磁带信息列表
      slot_indexStringslot索引
      slot_barcodeString磁带条形码
      slot_flagString磁带状态
    slot_tapenameString磁带组名
    bk_indexString数据编号
    bk_pathString数据内容
    bk_timeString备份时间
    archive_resultNumber备份结果1
    archive_sizeString备份数据量
    slot_indexStringSlot索引
    slot_barcodeString磁带条形码
    slot_tapesequenceString组内序号
    bk_set_idString备份任务ID
  totalNumber记录总数1

查看磁带 - 磁带数据

SDK方法名:listTapeMediaBkFiles;

URL

/tape_media/bkfiles

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
slot_barcodeString磁带条形码
bk_indexString备份编号
bk_pathString备份路径
limitString每页条目数
pageString页码

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray备份数据文件列表
    file_path_nameString文件路径名
  totalNumber总条目数1

查看磁带 - 磁带详情

SDK方法名:listTapeMediaDetails;

URL

/tape_media/details

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
slot_barcodeString磁带条形码
bk_indexString备份编号
bk_pathString备份路径
limitNumber页条数
pageNumber页码

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listObject
    bk_end_tmNumber0
    bk_filesNumber0
    bk_host_addrString192.168.31.33
    bk_host_nameStringadmin
    bk_node_nameString192.168.31.33Tape
    bk_pathString
    bk_rule_nameString4448FULL
    bk_rule_uuidStringB15A3BA8-7B4C-4B4D-9E8B-13ACC3D8223A
    bk_set_idStringadmin_1701681738
    bk_sizeNumber0
    bk_start_tmNumber0
    bk_typeNumber0
    bk_uuidString
    bkup_policyNumber0
    blk_sizeNumber0
    compressedNumber0
    concurrentNumber0
    content_typeNumber0
    copy_idNumber0
    disk_pool_nameString
    dst_osNumber0
    dst_storage_unitObject
      storage_unit_groupNumber0
      storage_unit_nameStringtape
      storage_unit_typeStringTAPELIBRARY
      storage_unit_type_numberNumber2
      storage_unit_uuidString
    expire_policyNumber0
    expire_tmNumber371086875969246
    extendObject
      reservedString
    fileCryptObject
      keyString
      ukey_InfoString
      valNumber0
    formatNumber0
    fragment_sizeNumber0
    i2node_verString
    index_serverString
    job_uuidString45197C24-558E-4F7C-8E05-B6462100638E
    metadata_pathString
    primary_copyNumber0
    retentionNumber0
    src_instanceString
    src_osNumber0
    src_typeNumber1
    stageNumber0
    tape_infoArray
    tape_libraryString
    tape_nameArray
    tape_poolString
    tape_snString
    task_uuidString
    verString
    wk_dirArray["/var/i2data/log/bakup_sysrun_2023-11-20.log","/var/i2data/log/bakup_sysrun_2023-11-21.log","/var/i2data/log/bakup_sysrun_2023-11-22.log","/var/i2data/log/bakup_sysrun_2023-11-23.log","/var/i2data/log/bakup_sysrun_2023-11-24.log"]
    wk_host_addrString192.168.31.33
    wk_host_nameStringadmin
    wk_node_nameString192.168.31.33Tape
    wk_uuidString555B77D1-86D6-4D14-8395-ED30266C1D85
    barcodeStringF01034L5

磁带库 - 发现新带库

SDK方法名:refreshTapeLibrary;

URL

/tape_library/refresh

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
bk_uuidsArray备份服务器uuid列表

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  info_listArray
    bk_uuidString备份服务器uuid
    task_uuidString异步任务uuid
    codeStringrpc调用结果,获取不到task_uuid时会报错,界面可以先判断下这个错误码

磁带库 - 机械臂主机列表

SDK方法名:listTapeLibraryRoboticArm;

URL

/tape_library/robotic_arm_list

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  robotic_arm_infoArray机械臂列表信息
    bk_uuidString机械臂主机uuidD42BF707-C971-EEA9-521F-BB0F3F7A92FC
    bk_node_nameString机械臂主机名称备份服务器1
    library_snString带库序列号SYZZ_A
    library_productString带库型号L80
    drive_numNumber驱动器数量1
    slot_numNumber槽数1
    dev_pathString设备路径/dev
    checkedBoolean是否勾选false
    server_typeNumber是否可用作机械臂主机0
Last update: 2/26/2024, 5:49:44 PM
Contributors: ganl