存储池
June 24, 2022About 9 min
存储池
SDK类名：/resource/StoragePool
扫描，获取存储机可用磁盘列表
SDK方法名：availablePoolMemberList
URL
/storage_pool/available_pool_member
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| config_addr | String | 备机地址:端口;127.0.0.1:8080 | |||
| pool_type | String | 存储类型，备机集群作为备机时为CephStorage | BlockStorage | ||
| storage_conf_ip | String | 【可选】存储管理地址ip，备机集群作为备机时必传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| member_tree | Array | ||||
| name | Array | ["sda","sdb"] | |||
| size | Number | 1024000 | |||
| type | String | disk | |||
| available | Number | 1 | |||
| child_member | Array | ||||
| name | Array | ["sda1","sda2"] | |||
| size | Number | 202404 | |||
| type | Array | ["partition","disk"] | |||
| available | Number | 0 | |||
| child_member | Array |
新建存储池
SDK方法名：createStoragePool
URL
/storage_pool
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_name | String | 是 | 存储池名称 | ||
| physical_name | String | 物理名称 | |||
| pool_type | String | 是 | 存储池类型：BlockStorage CephStorage | ||
| node_uuid | String | 关联节点uuid（可以为空） | |||
| ip | String | 是 | 备机地址:端口;127.0.0.1:8080 | ||
| data_addr | String | 数据地址 | |||
| disk_list | Array | 是 | 磁盘列表 | ||
| name | String | 磁盘名称 | |||
| size | String | 磁盘大小 | |||
| type | String | 磁盘类型 | |||
| description | String | 备注 | |||
| storage_conf_ip | String | 【可选】存储管理地址ip，CephStorage类型必传 | |||
| compress | Number | 是否开启压缩： 0：关；1：开。默认不勾选（存储类型为“BlockStorage”时显示，暂不支持修改） | 0 | ||
| dedup | Number | 是否开启去重： 0：关；1：开。默认不勾选（存储类型为“BlockStorage”时显示，暂不支持修改） | 0 | ||
| fc_as_target | Number | 是否作为fc客户端： 0：否； 1：是 | 0 | ||
| wwpn_info | Array | ||||
| tape_uuid | String | 关联的磁带库uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| uuid | String | 新建存储池的uuid | |||
| wwpn_del_fail_list | Array | ||||
| code | String | code为11116814，提供强制删除 | |||
| message | String | ||||
| wwpn | String | ||||
| wwpn_create_fail_list | Array | ||||
| wwpn | String | ||||
| code | String | ||||
| message | String | ||||
| msg | String |
修改存储池
SDK方法名：modifyStoragePool;
URL
/storage_pool/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_name | String | ||||
| physical_name | String | ||||
| pool_type | String | ||||
| node_uuid | String | 关联节点uuid | |||
| ip | String | 备机地址:端口;127.0.0.1:8080 | |||
| data_addr | String | 数据地址 | |||
| disk_list | Array | ||||
| name | String | ||||
| size | String | ||||
| type | String | ||||
| random_str | String | ||||
| description | String | ||||
| compress | Number | 0 | |||
| dedup | Number | 0 | |||
| fc_as_target | Number | 0 | |||
| wwpn_info | Array | ||||
| tape_uuid | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| uuid | String | 存储池uuid | |||
| wwpn_del_fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| wwpn | String | ||||
| wwpn_create_fail_list | Array | ||||
| wwpn | String | ||||
| code | String | ||||
| message | String | ||||
| msg | String |
查看列表
SDK方法名：storagePoolList;
URL
/storage_pool
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | String | 页数 | |||
| limit | String | 每页条数 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | ||||
| info_list | Array | ||||
| pool_uuid | String | 存储池uuid | @uuid | ||
| physical_name | String | ||||
| pool_name | String | 存储池名称 | @name | ||
| pool_type | String | 存储池类型 | storage | ||
| ip | String | 存储地址 | |||
| disk_list | Array | 磁盘列表 | |||
| name | String | 磁盘名称 | |||
| size | String | 磁盘大小 | |||
| type | String | 磁盘类型 | |||
| random_str | String | ||||
| description | String | 备注 | |||
| can_op | Number | 能否操作 | 1 | ||
| is_biz_admin | Number | 1 | |||
| fc_as_target | Number | 是否作为fc客户端： 0：否； 1：是 | |||
| wwpn_info | Array | HBA卡WWPN信息 | |||
| total | Number | 总条数 | 10 | ||
| code | Number | 0 | |||
| message | String | ||||
| msg | String | ||||
| ret | Number | 200 |
获取单个
SDK方法名：describeStoragePool;
URL
/storage_pool/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| storage_pool | Object | ||||
| pool_uuid | String | 存储池uuid | |||
| physical_name | String | ||||
| pool_name | String | 存储池名称 | |||
| pool_type | String | 存储池类型 | |||
| node_uuid | String | 关联节点uuid | |||
| ip | String | 存储地址 | |||
| data_addr | String | 数据地址 | |||
| disk_list | Array | 磁盘列表 | |||
| name | String | 磁盘名称 | |||
| size | String | 磁盘大小 | |||
| type | String | 磁盘类型 | |||
| random_str | String | ||||
| description | String | ||||
| compress | Number | 1 | |||
| dedup | Number | 1 | |||
| fc_as_target | Number | 0 | |||
| wwpn_info | Array | ||||
| tape_uuid | String |
删除
SDK方法名：deleteStoragePool;
URL
/storage_pool
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_uuids | Array | 存储池uuid | |||
| force | Number | 1 - 强制删除 0 - 非强制删除 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 11110001 | |||
| success_list | Array | ||||
| code | String | 11110001 | |||
| message | String | 删除成功 | |||
| pool_name | String | 存储池名称 | test2 | ||
| pool_uuid | String | 存储池uuid | BC92C981-D637-AC10-7CB0-450504DF8A3C | ||
| fail_list | Array | ||||
| code | String | 11110001 | |||
| message | String | 离线 | |||
| pool_name | String | 存储池名称 | test1 | ||
| pool_uuid | String | 存储池uuid | AB92C981-D637-AC10-7CB0-450504DF8A3C |
获取状态
SDK方法名：listStoragePoolStatus;
URL
/storage_pool/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_uuids | Array | 存储池uuid数组 | |||
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| status | Array | ||||
| pool_uuid | String | 存储池uuid | 1E984F7D-436C-c4cA-eA2D-C42FE3ADce6B | ||
| status | String | UNKNOW：未知， CLOSED：已关闭， OFFLINE：离线， REMOVED：已移除， CANT_OPEN：无法开启， FAULTED：设备故障， DEGRADED：降级运行， HEALTHY：正常运行， UNAVAIL：无效， ONLINE:在线， CREATEFAILE：创建失败， CREATING： 创建中 EXTENDING： 扩容中 | CREATEFAILE | ||
| size | Number | 存储池大小，单位byte | 4294967296 | ||
| alloc | Number | 存储池已使用大小，单位byte | |||
| free | Number | 存储池可用大小，单位byte | 4294967296 | ||
| compress | Boolean | 是否开了了压缩。 | false | ||
| compress_rate | String | 压缩率 | |||
| dedup | Boolean | 是否开了了去重。 | false | ||
| dedup_rate | String | 删重率 | |||
| extend_result | String | 空：不提示 EXTEND_FAILED：提示扩容失败 EXTEND_SUCCESS：提示扩容成功 |
获取 fc 目标端 hba卡信息
SDK方法名：listHbaInfo;
URL
/storage_pool/hba_info
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ip | String | 127.0.0.1:8080 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| hba_info | Array | ||||
| manufacturer | String | ||||
| serial_number | String | test1 | |||
| model | String | ||||
| model_desc | String | ||||
| vec_nodes | Array | ||||
| node_wwn | String | test2 | |||
| vec_ports | Array | ||||
| node_wwn | String | ||||
| port_wwn | String | test3 | |||
| port_type | String | ||||
| port_state | String | ||||
| port_speed | String | ||||
| is_as_target | String | 是否已创建目标端； 0：否；1：是 |
删除fc_target
SDK方法名：deleteFcTarget;
URL
/storage_pool/fc_target
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_uuid | String | 存储池uuid | |||
| wwpn | String | ||||
| force | Number | 强制删除; 0：否； 1：是; | 1 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
存储池 - 操作
SDK方法名：operateStoragePool;
URL
/storage_pool/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_uuids | Array | 存储池uuid | |||
| operate | String | reset：重新创建；extend：扩容 | |||
| add_disk_list | Array | 【可选】扩容必传，下发参数参考新建时disk_list，为选择的磁盘信息 | |||
| name | String | /dev/sdb | |||
| size | Number | 2000398934016 | |||
| type | String | disk |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
获取节点存储池列表
SDK方法名：storagePoolLoadPools;
URL
/storage_pool/load_pools
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| node_uuid | String | 节点uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| pool_list | Array | 存储池列表 | |||
| pool_name | String | 存储池名称 | pool_name | ||
| pool_type | String | 存储池类型 | BlockStorage | ||
| disk_list | Array | 磁盘 | |||
| name | String | 名称 | sdb | ||
| size | Number | 容量 | 64424509440 | ||
| type | String | 类型 | disk | ||
| compress | Number | 压缩 | 0 | ||
| dedup | Number | 删重 | 0 | ||
| pool_size | Number | 存储池容量 | 64424509440 | ||
| pool_free | Number | 存储池剩余容量 | 32424735820 |
批量导入存储池
SDK方法名：storagePoolBatchImport;
URL
/storage_pool/batch_import
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_list | Array | 存储池列表 | |||
| pool_name | String | ||||
| physical_name | String | ||||
| pool_type | String | ||||
| node_uuid | String | 关联节点uuid | |||
| ip | String | 节点，管理地址：管理端口 | |||
| disk_list | Array | ||||
| name | String | ||||
| size | String | ||||
| type | String | ||||
| description | String | ||||
| data_addr | String | 节点数据地址 | |||
| compress | Number | 0 | |||
| dedup | Number | 是 | 0 | ||
| fc_as_target | Number | 0 | |||
| storage_conf_ip | String | ||||
| wwpn_info | Array | ||||
| tape_uuid | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| success_list | Array | ||||
| pool_name | String | ||||
| fail_list | Array | ||||
| pool_name | String |
存储池 - 更新配置项
SDK方法名：storagePoolUpdateConfig;
URL
/storage_pool/update_config
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_uuid | String | 存储池uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String |