远程复制
November 18, 2022About 6 min
远程复制
SDK类名：/remoteRep/RemoteRep;
远程复制 - 新建
SDK方法名：createRemoteRep；
URL
/remote_rep
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_name | String | 远程复制名称 | |||
| wk_uuid | String | 源机uuid | |||
| bk_uuid | String | 备机uuid | |||
| rep_type | Number | 复制类型： 0：存储池； 1：复制卷或副本卷； 2：文件系统； 3：仅复制所选对象； | 0 | ||
| wk_pool_uuid | String | 源机存储池uuid | |||
| bk_pool_uuid | String | 备机存储池uuid | |||
| rule_uuid | String | 关联规则uuid，可选 | |||
| file_system | String | 文件系统，可选 | |||
| volume_uuid | String | 复制卷uuid，可选 | |||
| snapshot | String | 快照，可选 | |||
| clone_uuid | String | 副本卷uuid，可选 | |||
| sec_snapshot | String | 二级快照，可选 | |||
| sec_clone_uuid | String | 二级副本卷，可选 | |||
| bkup_policy | Number | 备份策略： 2：立即执行； 0：一次性； 1：周期； | |||
| bkup_one_time | Number | 定时任务，执行时间（备份策略） | |||
| bkup_window | Object | 运行时间范围 | |||
| sched_time_start | String | 开始 | |||
| sched_time_end | String | 结束 | |||
| bkup_schedule | Object | ||||
| limit | Number | 数据保留期限（天） | |||
| sched_day | Array | 哪几天 | |||
| sched_every | Number | 0：每天；1：每周：2：每月；3：每隔 | |||
| sched_time | Array | 哪几点 | |||
| sched_gap_min | Number | 间隔分钟数 | |||
| backup_type | Number | 备份类型： 0：全备/数据备份； 1：增量/日志备份； 2：差异； | |||
| encrypt_switch | Number | 传输加密开关： 0：关； 1：开 | 0 | ||
| encrypt | String | 加密类型 1：aes， 2：sm4 | |||
| secret_key | String | 加密秘钥 | |||
| compress_switch | Number | 传输压缩开关： 0：关； 1：开； | 0 | ||
| compress | Number | 压缩等级； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success |
远程复制 - 修改
SDK方法名：modifyRemoteRep；
URL
/remote_rep/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_name | String | ||||
| wk_uuid | String | ||||
| bk_uuid | String | ||||
| rep_type | Number | 0 | |||
| wk_pool_uuid | String | ||||
| bk_pool_uuid | String | ||||
| rule_uuid | String | ||||
| file_system | String | ||||
| volume_uuid | String | ||||
| snapshot | String | ||||
| clone_uuid | String | ||||
| sec_snapshot | String | ||||
| sec_clone_uuid | String | ||||
| bkup_policy | Number | 1 | |||
| bkup_one_time | Number | 1 | |||
| bkup_schedule | Object | ||||
| limit | Number | 1 | |||
| sched_day | Array | ||||
| sched_every | Number | 1 | |||
| sched_time | Array | ||||
| sched_gap_min | Number | 1 | |||
| backup_type | Number | 1 | |||
| bkup_window | Object | ||||
| sched_time_start | String | ||||
| sched_time_end | String | ||||
| random_str | String | 随机字符串 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success |
远程复制 - 列表
SDK方法名：listRemoteRep；
URL
/remote_rep
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| limit | Number | 10 | |||
| page | Number | 1 | |||
| search_field | String | ||||
| search_value | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| info_list | Array | ||||
| rep_uuid | String | ||||
| rep_name | String | ||||
| rep_type | String | ||||
| wk_uuid | String | ||||
| wk_node_name | String | ||||
| bk_uuid | String | ||||
| bk_node_name | String |
远程复制 - 获取单个
SDK方法名：describeRemoteRep；
URL
/remote_rep/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | [0] success | |||
| code | Number | 0 | |||
| remote_rep | Object | ||||
| rep_name | String | ||||
| wk_uuid | String | ||||
| bk_uuid | String | ||||
| rep_type | Number | 0 | |||
| wk_pool_uuid | String | ||||
| bk_pool_uuid | String | ||||
| rule_uuid | String | ||||
| file_system | String | ||||
| volume_uuid | String | ||||
| snapshot | String | ||||
| clone_uuid | String | ||||
| sec_snapshot | String | ||||
| sec_clone_uuid | String | ||||
| bkup_policy | Number | 1 | |||
| bkup_one_time | Number | 1 | |||
| bkup_schedule | Object | ||||
| limit | Number | 1 | |||
| sched_day | Array | ||||
| sched_every | Number | 1 | |||
| sched_time | Array | ||||
| sched_gap_min | Number | 1 | |||
| backup_type | Number | 1 | |||
| bkup_window | Object | ||||
| sched_time_start | String | ||||
| sched_time_end | String | ||||
| random_str | String |
远程复制 - 操作
SDK方法名：operateRemoteRep；
URL
/remote_rep/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuids | Array | ||||
| operate | String | start, stop, start_immediately |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [-1] 离线 | |||
| rep_uuid | String | @guid | |||
| rep_name | String | test2 | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rep_uuid | String | @guid | |||
| rep_name | String | test1 |
远程复制 - 删除
SDK方法名：deleteRemoteRep；
URL
/remote_rep
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuids | Array | ||||
| force | Number | 1：强制删除； 0：非强制删除； | |||
| del_policy | Number | 是否删除备份规则： 0：不开启；1：开启； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [-1] 离线 | |||
| rep_uuid | String | @guid | |||
| rep_name | String | test2 | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rep_uuid | String | @guid | |||
| rep_name | String | test1 |
远程复制 - 状态
SDK方法名：listRemoteRepStatus
URL
/remote_rep/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuids | Array | ||||
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| count | String | 1 | |||
| message | String | ||||
| code | Number | 0 | |||
| status | Array | ||||
| status | String | ||||
| progress | Number | ||||
| rep_uuid | String |
根据存储池获取规则列表
SDK方法名：listStoragePoolRuleList；
URL
/remote_rep/storage_pool_rules
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_type | Number | 远程复制类型，对应新建时的字段 | |||
| pool_uuid | String | 源机存储池uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| rule_list | Array | ||||
| uuid | String | 规则uuid | |||
| name | String | 规则名称 | |||
| volume_uuid | String | 复制卷uuid | |||
| volume_name | String | 复制卷名称 |
根据存储池获取文件系统列表
SDK方法名：listFileSystem；
URL
/remote_rep/file_system
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| pool_uuid | String | 存储池uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| quota_list | Array | ||||
| zfs_name | String | 文件系统 | |||
| zfs_mount_path | String | 挂载路径 |
获取（二级）副本卷
SDK方法名：describeCloneVolume；
URL
/remote_rep/clone_volume
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| volume_uuid | String | 是 | 复制卷uuid、一级副本卷uuid | ||
| snapshot_time | String | 快照时间点 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| data | Object | ||||
| task_uuid | String | 副本卷uuid | |||
| task_name | String | 副本卷名称 |
根据备份规则过滤存储节点
SDK方法名：filterStorageNode；
URL
/remote_rep/filter_storage
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuid | String | 备份规则uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| storage | Array | ||||
| uuid | String | 存储节点uuid | |||
| name | String | 存储节点名称 |
远程恢复 - 文件合成备份还原时间点
SDK方法名：listFileSnapshot；
URL
/remote_rep/file_snapshot_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuid | String | 备份规则uuid（用来获取卷） | |||
| pool_uuid | String | 存储池uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| snap_list | Array | [ "2022-05-11_13-24-59", "2022-05-11_13-43-06", "2022-05-11_13-44-15" ] |