存储单元
February 26, 2024About 8 min
存储单元
SDK类名：/resource/StorageUnit
示例接口
示例接口描述
URL
/example/1687925291541
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| foo | String | 请求属性示例 | @ctitle |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| string | String | 字符串属性示例 | ★ | 1-10 | |
| number | Number | 数字属性示例 | 1 | 1-100 | |
| boolean | Boolean | 布尔属性示例 | true | 1-2 | |
| regexp | RegExp | 正则属性示例 | /[a-z][A-Z][0-9]/ | ||
| function | Function | 函数属性示例 | () => Math.random() | ||
| array | Array | 数组属性示例 | 1-10 | ||
| foo | Number | 数组元素示例 | 1 | +1 | |
| bar | String | 数组元素示例 | ★ | 1-10 | |
| items | Array | 自定义数组元素示例 | [1, true, 'hello', /\w{10}/] | ||
| object | Object | 对象属性示例 | |||
| foo | Number | 对象属性示例 | 1 | +1 | |
| bar | String | 对象属性示例 | ★ | 1-10 | |
| placeholder | String | 占位符示例 | @title |
存储单元 - 准备(查看容量)
SDK方法名：getStorageUnitBkCapacity;
URL
/storage_unit/capacity
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_uuid | String | ||||
| storage_path | String | ||||
| unit_type | Number | ||||
| fs_uuid | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| total_size | String | ||||
| alail_size | String | ||||
| usage | String | ||||
| storage_path | String | 存储路径，用于选择存储池时查看容量界面显示 | |||
| msg | String |
存储单元 - 获取驱动数量
SDK方法名：getStorageUnitDrivers;
URL
/storage_unit/drivers
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| library_uuid | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| drivers | Number | 驱动数量 | 0 | ||
| msg | String |
存储单元 - 新建
SDK方法名：createStorageUnit;
URL
/storage_unit
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| unit_name | String | 存储单元名称 | |||
| unit_type | Number | 存储单元类型 0 - DISK - 本地磁盘 1 - OBS - 对象存储 2 - TAPELIBRARY - 磁带库 3 - DISKPOOL - 存储池 | |||
| bk_uuid | String | 备份服务器 | |||
| data_ip_uuid | String | 备份地址 | |||
| storage_path | String | 存储路径 | |||
| max_concurrent | Number | 最大并发数 | |||
| fragment_switch | Number | 启用分片 0 - 不勾选 1 - 勾选 | |||
| fragment_size | Number | 分片大小 | |||
| high_water_mark | Number | 高水位 | |||
| low_water_mark | Number | 低水位 | |||
| auto_expand | Number | 自动扩充 0 - 不勾选 1 - 勾选 | |||
| library_uuid | String | 带库 | |||
| drivers_num | Number | 驱动器数量 | |||
| rootfs | Number | 系统磁盘允许 0 - 不勾选 1 - 勾选 | |||
| pool_uuid | String | 存储池uuid | |||
| fs_uuid | String | 文件系统uuid | |||
| biz_grp_list | String | 分组关系, 当前资源绑定的组uuid列表； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
存储单元 - 修改
SDK方法名：modifyStorageUnit;
URL
/storage_unit/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| unit_name | String | ||||
| unit_type | String | ||||
| bk_uuid | String | ||||
| data_addr | String | ||||
| storage_path | String | ||||
| max_concurrent | Number | 1 | |||
| fragment_switch | Number | 1 | |||
| fragment_size | Number | 1 | |||
| high_water_mark | Number | 1 | |||
| low_water_mark | Number | 1 | |||
| auto_expand | Number | 1 | |||
| library_uuid | String | ||||
| drivers_num | Number | 1 | |||
| rootfs | Number | 1 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
存储单元 - 单个
SDK方法名：describeStorageUnit;
URL
/storage_unit/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| storage_unit | Object | ||||
| pool_uuid | String | ||||
| storage_path | String | /wenctest1/ | |||
| bk_uuid | String | 56DA03BD-8753-4205-BAA8-53985C859F02 | |||
| data_ip_uuid | String | 25526053-BD2E-4E86-A919-44261FB5C429 | |||
| max_concurrent | Number | 10 | |||
| fragment_switch | Number | 1 | |||
| rootfs | Number | 1 | |||
| unit_type | Number | 0 | |||
| high_water_mark | Number | 90 | |||
| low_water_mark | Number | 75 | |||
| unit_name | String | test2 | |||
| unit_uuid | String | 56DA03BD-8753-4205-BAA8-53985C859F02 | |||
| fs_uuid | String | ||||
| bk_node_name | String | storage_202 | |||
| fragment_size | String | 2 | |||
| random_str | String | ||||
| code | Number | 0 |
存储单元 - 列表
SDK方法名：listStorageUnit;
URL
/storage_unit
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| where_args | Array | ||||
| unit_type | String | 根据存储单元类型过滤 | |||
| unit_name | String | 根据存储单元名称过滤 | |||
| like_args | Array | ||||
| bk_node_name | String | 根据备份服务器名称过滤 多个名称逗号分割 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | ||||
| unit_name | String | unit1 | |||
| unit_uuid | String | E95CB20B-917C-57F4-F926-751ECE95F861 | |||
| unit_type | String | ||||
| bk_uuid | String | ||||
| data_addr | String | ||||
| storage_path | String | ||||
| max_concurrent | Number | 1 | |||
| fragment_switch | Number | 1 | |||
| fragment_size | Number | 1 | |||
| high_water_mark | Number | 1 | |||
| low_water_mark | Number | 1 | |||
| auto_expand | Number | 1 | |||
| tape_uuid | String | ||||
| drivers_num | Number | 1 | |||
| rootfs | Number | 1 | |||
| id | String | 5 | |||
| create_time | String | 1597546626 | |||
| can_op | Number | 1 | |||
| can_del | Number | 1 | |||
| is_biz_admin | Number | 1 | |||
| total | Number | 1 |
存储单元 - 删除
SDK方法名：deleteStorageUnit;
URL
/storage_unit
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| unit_uuids | Array | ||||
| force | Number |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 11110001 | |||
| success_list | Array | ||||
| code | String | 11110001 | |||
| message | String | 删除成功 | |||
| name | String | test2 | |||
| unit_uuid | String | BC92C981-D637-AC10-7CB0-450504DF8A3C | |||
| fail_list | Array | ||||
| code | String | 11110001 | |||
| message | String | 离线 | |||
| name | String | test1 | |||
| unit_uuid | String | AB92C981-D637-AC10-7CB0-450504DF8A3C | |||
| can_force_del | Number | 是否可以强制删除，0：否，1：是 |
存储单元 - 状态
SDK方法名：listStorageUnitStatus;
URL
/storage_unit/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| unit_uuids | Array | ||||
| force_refresh | Number |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| status | Array | ||||
| unit_uuid | String | ||||
| total_size | Number | 1 | |||
| avail_size | Number | 1 | |||
| used_rate | Number | 10.1 | |||
| status | String | OFFLINE - 离线(默认) NORMAL - 正常 ERROR - 错误 SPACE_FULL - 空间满 SPACE_WARNNING - 空间警告 POOL_DEGRAGED - 存储池错误 POOL_FAULTED - 存储池错误 POOL_OFFLINE - 存储池离线 POOL_UNAVAIL - 存储池不可用 POOL_REMOVED - 存储池移除 | OFFLINE |
--------------------
URL
/dash
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
存储单元组 - 新建
SDK方法名：createStorageUnitGroup;
URL
/storage_unit_group
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| group_name | String | 组名称 | |||
| group_type | Number | 存储单元类型 0 - DISK - 本地磁盘 1 - OBS - 对象存储 2 - TAPELIBRARY - 磁带库 3 - DISKPOOL - 存储池 | |||
| unit_list | Array | 存储单元列表 | |||
| policy | Number | 存储单元选择策略： 0 - 按优先级(从上到下选择可用的存储单元) 1 - 最近使用优先(优先选择上次备份的存储单元， 如果不可用，从上到下选择一个可用的) 2 - 负载均衡(按照”运行任务数/存储单元最大并发数” 计算负载) |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
存储单元组 - 修改
SDK方法名：modifyStorageUnitGroup;
URL
/storage_unit_group/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| group_name | String | ||||
| group_uuid | String | ||||
| group_type | String | ||||
| unit_list | Array | ||||
| policy | Number | 1 | |||
| random_str | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
存储单元组 - 单个
SDK方法名：describeStorageUnitGroup;
URL
/storage_unit_group/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| storage_unit_group | Object | ||||
| group_name | String | ||||
| group_uuid | String | ||||
| group_type | Number | 1 | |||
| random_str | String | ||||
| unit_list | Array | ||||
| policy | Number | 1 | |||
| etcd_url_uuid | String | ||||
| etcd_url | Array | ||||
| ip | String | ||||
| port | String | ||||
| code | Number | 0 |
存储单元组 - 列表
SDK方法名：listStorageUnitGroup;
URL
/storage_unit_group
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| where_args | Array | ||||
| group_type | Number | 根据存储单元组类型过滤 | |||
| like_args | Array | ||||
| group_name | String | 根据存储单元组名称过滤 | |||
| unit_name | String | 根据存储单元名称过滤 多个逗号分割 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | ||||
| group_name | String | ||||
| group_type | String | ||||
| unit_list | Array | ||||
| unit_name_list | String | ||||
| policy | Number | 1 | |||
| id | String | 5 | |||
| create_time | String | 1597546626 | |||
| can_op | Number | 1 | |||
| can_del | Number | 1 | |||
| is_biz_admin | Number | 1 | |||
| group_uuid | String | E95CB20B-917C-57F4-F926-751ECE95F812 | |||
| total | Number | 1 |
存储单元组 - 删除
SDK方法名：deleteStorageUnitGroup;
URL
/storage_unit_group
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| group_uuids | Array | ||||
| force | Number |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 11110001 | |||
| success_list | Array | ||||
| code | String | 11110001 | |||
| message | String | 删除成功 | |||
| name | String | test2 | |||
| group_uuid | String | BC92C981-D637-AC10-7CB0-450504DF8A3C | |||
| fail_list | Array | ||||
| code | String | 11110001 | |||
| message | String | 离线 | |||
| name | String | test1 | |||
| group_uuid | String | AB92C981-D637-AC10-7CB0-450504DF8A3C |
存储单元 - 提交前检查
SDK方法名：chkStorageUnitRules;
URL
/storage_unit/rules_chk
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| storage_path | String | 存储路径 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| list | Array | 存储单元名称，用于界面提示 | ["storage1","storage2"] |