复制卷
June 24, 2022About 7 min
复制卷
SDK类名：/resource/CopyVolume
复制卷 - 新建
SDK方法名：createCopyVolume；
URL
/copy_volume
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_name | String | 复制卷名称 | |||
| bk_uuid | String | 客户端uuid，普通节点,rac集群,英方服务集群 | |||
| bk_type | String | 客户端类型：node, rac, service_cls | |||
| pool_uuid | String | 存储池uuid | |||
| volume_size | String | 卷容量，单位 GB | |||
| link_protocol | String | iSCSI, FC | |||
| create_fs | Number | 创建文件系统： 0：不创建； 1：存储端； 2：客户端； | |||
| fs_type | String | 文件系统类型，ntfs、ext4、xfs | |||
| attach_point | Array | 挂载点， 如果选择服务集群可选择auto，值为['auto'] | |||
| fc_initiator_wwpn | String | fc客户端wwpn | |||
| fc_target_wwpn | String | fc目标端wwpn | |||
| exclusive | Number | 是否独占：0-不勾选, 1-勾选 | |||
| auto_switch | Number | 自动开关，0-关 1-开 只有客户端选择服务集群时才会显示，默认0，当选择1时挂载的的值为'auto'，禁止选择挂载的。 | |||
| sparse_switch | Number | 0-不启用 1-启用 若选择基于zfs的存储池，可提供开关选项，启用精简置备（thin provisioning），默认启用 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
复制卷 - 修改
SDK方法名：modifyCopyVolume；
URL
/copy_volume/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_name | String | 复制卷名称 | |||
| bk_uuid | String | 客户端uuid，普通节点,rac集群,英方服务集群 | |||
| volume_size | String | 卷容量，单位 GB |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| msg | String |
复制卷 - 单个
SDK方法名：describeCopyVolume;
URL
/copy_volume/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| copy_volume | Object | ||||
| volume_name | String | rep_test | |||
| bk_uuid | String | @uuid | |||
| pool_uuid | String | @uuid | |||
| link_protocol | String | iSCSI | |||
| volume_size | Number | 150 | |||
| create_fs | Number | 1 | |||
| fs_type | String | ntfs | |||
| attach_point | String | E: | |||
| fc_initiator_wwpn | String | ||||
| fc_target_wwpn | String | ||||
| exclusive | Number | 1 | |||
| bk_type | String | service_cls | |||
| status | String | 挂载状态: MOUNTED：挂载 UNMOUNTED: 未挂载 UNKNOWN: 未知 | |||
| hostname | String | 节点主机名称 | |||
| code | Number | 0 |
复制卷 - 列表
SDK方法名：copyVolumeList;
URL
/copy_volume
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| where_args['bk_uuid'] | String | ||||
| where_args['wk_uuid'] | String | ||||
| where_args['create_fs'] | Number | 0 | |||
| where_args['name'] | String | 复制卷名 | |||
| where_args['pool_name'] | String | 存储池名 | |||
| where_args['bk_node_name'] | String | 客户端名 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | ||||
| username | String | admin | |||
| user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| id | String | 5 | |||
| volume_uuid | String | E95CB20B-917C-57F4-F926-751ECE95F869 | |||
| volume_name | String | copy-volume1 | |||
| bk_uuid | String | 65E3E4A5-D089-8B6A-25F3-096F6997E3F0 | |||
| volume_size | String | 80 | |||
| link_protocol | String | iSCSI | |||
| create_fs | String | 1 | |||
| fs_type | String | ntfs | |||
| pool_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| pool_name | String | storage_name | |||
| attach_point | Array | ["/data"] | |||
| create_time | String | 1597546626 | |||
| bk_node_name | String | test_node | |||
| pool_type | String | ||||
| used | Number | 新建快照任务界面专用：已被快照任务使用为1，否则为0 | 0 | ||
| can_op | Number | 1 | |||
| can_del | Number | 1 | |||
| is_biz_admin | Number | 1 | |||
| fc_as_target | Number | 存储池是否作为目标端 | 0 | ||
| wwpn_info | Array | ||||
| status | String | 复制卷实时状态，返回值同状态接口所返回的status字段 | |||
| backup_enabled | Boolean | 合成备份，当前复制卷是否可选； 复制卷状态为在线，并且没有关联其他规则时为true； 否则为false; | |||
| dto_enabled | Boolean | DTO，当前复制卷是否可选； 复制卷状态为挂载，并且没有关联其他规则时为true； 否则为false; | |||
| total | Number | 1 |
复制卷 - 删除
SDK方法名：deleteCopyVolume;
URL
/copy_volume
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_uuids | Array | ||||
| force | Number | 1 - 强制删除 0 - 非强制删除 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | 离线 | |||
| volume_uuid | String | BC92C981-D637-AC10-7CB0-450504DF8A3C | |||
| volume_name | String | test2 | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | 删除成功 | |||
| volume_uuid | String | AB92C981-D637-AC10-7CB0-450504DF8A3C | |||
| volume_name | String | test | |||
| ret | Number | 200 |
复制卷 - 操作
SDK方法名：{operate}CopyVolume;
URL
/copy_volume/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 挂载：mount； 卸载：unmount | |||
| volume_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| success_list | Array | ||||
| code | String | ||||
| message | String | ||||
| volume_uuid | String | 34A49235-12F5-4E21-205F-4D8FAACA4079 | |||
| volume_name | String | task_name | |||
| fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| volume_uuid | String | 34A49235-12F5-4E21-205F-4D8FAACA4079 | |||
| volume_name | String | task_name |
复制卷 - 状态
SDK方法名：listCopyVolumeStatus
URL
/copy_volume/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_uuids | Array | ||||
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| status | Array | ||||
| volume_uuid | String | E95CB20B-917C-57F4-F926-751ECE95F869 | |||
| status | String | EXIST, 存在 INEXISTENCE, 不存在 ONLINE, 在线 OFFLINE, 离线 READONLY 只读 CREATING 创建中 CREATEFAILE 创建失败 UNMOUNTED 未挂载 MOUNTED 已挂载 | CREATEFAILE | ||
| used | Number | 102300 | |||
| free | Number | 100000 | |||
| size | Number | ||||
| refer | String | 卷占用空间 | 1073741824 | ||
| fs_avail | String | 文件系统可用空间 | 1073741824 |
获取单个卷快照列表
SDK方法名：listSnapshotList；
URL
/copy_volume/:uuid([A-F0-9-]+)/snapshot_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_type | Number | 卷类型：0-复制卷；1-一级副本卷 | 0 | ||
| page | Number | 页数 | 1 | ||
| limit | Number | 条数 | 10 | ||
| from | Number | 从什么时候开始 | 0 | ||
| to | Number | 到什么时候结束 | 0 | ||
| storage_uuid | String | 存储节点_uuid（远程恢复） | |||
| storage_pool_uuid | String | 存储池uuid（远程恢复） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| snapshot_list | Array | 2 | |||
| snapshot_name | String | 快照名称 | testpool/13CB1D17-D0E7-169A-D6DC-9CFB32341989@2020-06-17-11:30:51 | ||
| snapshot_time | String | 快照时间点 | 2020-11-11 01:30:51 | +1 | |
| snapshot_time_raw | String | 底层返回的，带前缀的，快照时间点 | Backup-2022-07-06_15:44:17 | ||
| clone_list | Array | 副本卷 | ["testpool/13CB1D17-D0E7-169A-D6DC-9CFB32341989@2020-06-17-11:30:51_clone1","testpool/13CB1D17-D0E7-169A-D6DC-9CFB32341989@22020-06-17-11:30:51_clone2"] | ||
| total | Number | 1 |
复制卷/副本卷 - 列表
SDK方法名：listCopyCdmVolume;
URL
/copy_volume/copy_cdm_volume
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_uuid | String | 根据复制卷uuid过滤 | |||
| volume_type | Number | 根据卷类型过滤： 0-复制卷 1-一级副本卷 2-二级副本卷 | |||
| bk_uuid | String | 根据客户端id过滤 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| list | Array | ||||
| volume_uuid | String | 复制卷uuid | 7BDDCD61-BB7E-42A7-C844-1C02BFBE7E86 | ||
| volume_name | String | 复制卷名称 | test-2008-db | ||
| cdm_name | Null | 副本卷名称 | |||
| cdm_uuid | Null | 副本卷uuid | |||
| volume_type | Number | 卷类型： 0-复制卷 1-一级副本卷 2-二级副本卷 | 0 | ||
| bk_uuid | String | 客户端uuid | BE44B0EB-741F-B267-88D9-445212A4A942 | ||
| create_time | Number | 卷的创建时间 | 1621220869 | ||
| status | String | 卷的状态 | |||
| user_uuid | String | 用户uuid | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | ||
| fc_initiator_wwpn | Null | ||||
| fc_target_wwpn | Null |
复制卷 - 新建 准备 获取客户端列表
SDK方法名：listCopyVolumeClient;
URL
/copy_volume/client_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| limit | Number | 300 | |||
| page | Number | 1 | |||
| type | Number | 节点 - node RAC集群 - rac 服务集群 - service_cls |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | ||||
| username | String | admin | |||
| user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| uuid | String | E95CB20B-917C-57F4-F926-751ECE95F869 | |||
| name | String | copy-volume1 | |||
| status | String | ONLINE | |||
| wwpn_info | Array | ||||
| total | Number | 1 | |||
| type | String | 节点 - node RAC集群 - rac 服务集群 - service_cls | node |