磁盘池

August 1, 2024About 4 min

磁盘池

SDK类名:/resource/diskPool

示例接口

示例接口描述

URL

/example/1718177918652

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方法名:listDiskPool;

URL

/disk_pool

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
like_argsObject
  pool_nameString名称搜索 模糊搜索
where_argsObject
  pool_typeNumber类型过滤
  bk_uuidArray备份服务器uuid数组 过滤

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] success
  info_listArray
    pool_nameString名称
    pool_uuidStringuuidE95CB20B-917C-57F4-F926-751ECE95F869
    pool_typeString类型
    bk_uuidString备份服务器uuid
    bk_node_nameString备份服务器名称
    storage_pathString存储路径
    max_concurrentNumber最大并发数1
    storage_unit_numNumber存储单元引用数2
    usernameString用户名admin
    user_uuidString用户uuid1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    create_timeString创建时间1597546626
    can_opNumber可操作1
    can_delNumber可删除1
    is_biz_adminNumber是否有管理员权限1
  totalNumber总数1

磁盘池 - 新建

SDK方法名:createDiskPool;

URL

/disk_pool

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
pool_nameString磁盘池名称
pool_uuidString磁盘池uuid
pool_typeNumber磁盘池类型:
0 -本地磁盘
1- 对象存储
3 - zfs文件系统
5 - 重删存储
4 - nas存储
bk_uuidString备份服务器
storage_pathString【本地磁盘、nas存储】
存储路径
rootfsNumber【本地磁盘】系统盘允许
0-不勾选 1-勾选
zfs_pool_uuidString【zfs文件系统】zfs池uuid
auto_expandNumber【zfs文件系统】自动扩充
0-不勾选 1-勾选
zfs_fs_uuidString【zfs文件系统】zfs文件系统uuid
max_concurrentNumber【zfs文件系统、重删存储、对象存储、nas存储】存储最大并发数
dedupe_sto_uuidString【重删存储】重删存储uuid
domain_uuidString【重删存储】指纹域uuid
sto_uuidString【对象存储】对象存储uuid
bucket_uuidString【对象存储】对象桶uuid
nas_typeString【NAS存储】NAS类型
只支持NFS 未来支持CIFS
NFS
export_pathString【NAS存储】导出路径

Response

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

磁盘池 - 修改

SDK方法名:modifyDiskPool;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
pool_uuidString磁盘池uuid
pool_nameString磁盘池名称
random_strString更新标识
bk_uuidString备份服务器
max_concurrentNumber最大并发数
zfs_pool_uuidStringzfs池uuid
auto_expandString自动扩充
zfs_fs_uuidStringzfs文件系统uuid

Response

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

磁盘池 - 单个

SDK方法名:describeDiskPool;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  disk_poolObject
    pool_nameString
    pool_uuidString
    pool_typeString
    bk_uuidString
    storage_pathString
    rootfsNumber1
    zfs_pool_uuidString
    auto_expandNumber1
    zfs_fs_uuidString
    max_concurrentNumber1
    dedupe_sto_uuidString
    domain_uuidString
    sto_uuidString
    bucket_uuidString
    nas_typeStringNFS
    export_pathString
    user_uuidString
    random_strString
    create_timeNumber112345678

磁盘池 - 删除

SDK方法名:deleteDiskPool;

URL

/disk_pool

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
pool_uuidsArray磁盘池uuid列表

Response

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

磁盘池 - 检查

SDK方法名:checkDiskPool;

URL

/disk_pool/check

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
bk_uuidString备份服务器uuid
storage_pathString存储路径
pool_uuidString磁盘池uuid

Response

名称类型必选简介Mock初始值Mock规则
msgString
retNumber200
dataObject
  codeNumber0
  messageStringsuccess
Last update: 8/1/2024, 2:00:50 PM
Contributors: ganl