CFS复制规则
February 26, 2024About 11 min
CFS复制规则
SDK类名：/cfs/CfsBackup
CFS - 新建
SDK方法名：createCfsBackup;
URL
/cfs_backup
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cfs_backup | Object | ||||
| rep_name | String | 规则名称 | rep_backup | ||
| rep_uuid | String | 前端生成的规则uuid，接口兼容处理，如果前端不传接口会自己处理 | B8166905-411E-B2CD-A742-77B1346D8E84 | ||
| rep_type | Number | 固定传3，表示cfs规则 | 0 | ||
| src_cfs_uuid | String | 源集群uuid | |||
| src_filesystem_id | String | 源文件系统id | |||
| src_zone_id | String | 源可用区id | |||
| wk_uuid | String | 工作机uuid | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
| tgt_cfs_uuid | String | 目标集群uuid | |||
| tgt_filesystem_id | String | 目标文件系统id | |||
| tgt_zone_id | String | 目标可用区id | |||
| bk_uuid | String | 灾备机uuid | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
| proxy_uuid | String | 代理uuid | |||
| data_ip_uuid | String | 灾备机数据地址uuid | B8166905-411E-B2CD-A742-77B1346D8E84 | ||
| file_type_filter_switch | Number | 文件类型过滤： 0：包含； 1：排除； | 0 | ||
| file_type_filter | String | 文件类型过滤，比如：.doc,.docx | |||
| auto_start | Number | 规则自动启动： 0：否； 1：是； | 1 | ||
| bkup_one_time | Number | 规则预约启动时间 | 1515568566 | ||
| bk_path_policy | Number | 映射类型： 0：一对一； 1：多对一； | 1 | ||
| wk_path | Array | 工作路径 | ["E:\test\"] | ||
| bk_path | Array | 备份路径 | ["E:\test2\"] | ||
| excl_path | Array | 排除路径 | |||
| mirr_skip | Number | 镜像设置 -跳过镜像： 0：正常镜像； 1：直接进入复制状态； 2：仅同步目录； | 0 | ||
| mirr_file_check | Number | 镜像设置 - 校验方式： 校验方式： 0：总是严格校验（md5）； 1：时间校验，不一致则严格校验； 2：时间校验，不一致则覆盖目标文件； 3：总是覆盖目标文件； | 0 | ||
| mirr_hash_type | Number | 镜像设置 - 校验算法： 0：md5； 1：sha256； | |||
| mirr_sync_flag | Number | 镜像设置 - 错误处理方式： 0：遇到错误停止； 1：写日志； | 0 | ||
| mirr_open_type | Number | 镜像设置 - 文件打开方式： 0：普通文件； 1：自动选； 2：MFT； | 0 | ||
| mirr_sync_attr | Number | 镜像设置 - 文件安全属性： 0：不同步； 1：同步； | 1 | ||
| traversing_sync | Number | 镜像设置 - 遍历时镜像： 0：关； 1：开； | 1 | ||
| thread_num | Number | 镜像设置 - 并行任务数 | 0 | ||
| oph_policy | Number | 镜像设置 - 孤儿文件处理方式： 0：不处理； 1：删除； 2：移动到指定路径； 6：归档； | 2 | ||
| oph_path | String | 镜像设置 - 孤儿文件处理路径 | E:\test4\ | ||
| compress_switch | Number | 压缩加密 - 传输压缩开关： 0：关； 1：开； | 1 | ||
| compress | Number | 压缩加密 - 传输压缩类型： 0：不开启； 1，极速； 2，普通； 3，快速； 4：均衡； | 0 | ||
| encrypt_switch | Number | 压缩加密 - 传输加密开关： 0：关； 1：开； | 0 | ||
| encrypt | Number | 压缩加密 - 传输加密类型： 0：不加密； 1：AES； 2：SM4； | 1 | ||
| bk_file_crypt | Number | 压缩加密 - 备端数据加密： 0：关； 1：开； | 0 | ||
| band_width | String | 带宽设置 | |||
| buf_in_bk | Number | 高级设置 - 备机增量数据缓存 0：关； 1：开； | 1 | ||
| rep_oph_switch | Number | 高级设置 - 复制删除文件处理 0：关； 1：开； | 1 | ||
| rep_oph_policy | Number | 高级设置 - 复制删除文件策略： 1：过滤删除； 2：归档； 3：重命名； | 0 | ||
| rep_oph_path | String | 高级设置 - 复制删除文件归档路径 | |||
| latency_threshold | Number | 高级设置 - 复制延迟阈值 | 1 | ||
| ct_name_type | Number | 高级设置 - 文件名替换： 0：不启用； 1：加前后缀，原来部分保持不变； 2：前后缀加小写； 3：前后缀加大写； 4：自定义； | 0 | ||
| ct_name_str1 | String | 文件名转换：prefix string / regex string | |||
| ct_name_str2 | String | 文件名转换：suffix string / replace string | |||
| ct_name_str3 | String | 文件名转换：restore regex string | |||
| ct_name_str4 | String | 文件名转换：restore regex string | |||
| mirr_sched_switch | Number | 高级设置 - 启用禁止镜像： 1；关闭：0；（block也有） | 0 | ||
| mirr_sched | String | 高级设置 - 禁止镜像策略； Eg: 303:00-14:00,202:00-15:00（block也有） | |||
| mir_detect_script | String | 高级设置 - 备端检测脚本 | |||
| mir_detect_src_script | String | 高级设置 - 源端检测脚本 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String |
CFS - 修改
SDK方法名：modifyCfsBackup；
URL
/cfs_backup/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cfs_backup | Object | ||||
| mirr_sync_attr | Number | 1 | |||
| oph_path | String | E:\test4\ | |||
| rep_name | String | rep_backup | |||
| bk_path_policy | Number | 1 | |||
| mirr_open_type | Number | 0 | |||
| compress | Number | 0 | |||
| encrypt_switch | Number | 0 | |||
| auto_start | Number | 1 | |||
| wk_path | Array | ["E:\test\"] | |||
| src_zone_id | String | ||||
| tgt_zone_id | String | ||||
| band_width | String | ||||
| mirr_sync_flag | Number | 0 | |||
| bk_path | Array | ["E:\test2\"] | |||
| wk_uuid | String | B8566905-411E-B2CD-A742-77B1346D8E84 | |||
| mirr_file_check | Number | 0 | |||
| rep_type | Number | 0 | |||
| file_type_filter_switch | Number | 0 | |||
| file_type_filter | String | ||||
| oph_policy | Number | 2 | |||
| mirr_skip | String | 0 | |||
| bk_uuid | String | B8566905-411E-B2CD-A742-77B1346D8E84 | |||
| excl_path | Array | ||||
| mirr_sched | String | ||||
| bkup_one_time | Number | 1515568566 | |||
| mirr_sched_switch | Number | 0 | |||
| ct_name_type | Number | 0 | |||
| ct_name_str1 | String | ||||
| ct_name_str2 | String | ||||
| ct_name_str3 | String | ||||
| ct_name_str4 | String | ||||
| thread_num | Number | 0 | |||
| latency_threshold | Number | 1 | |||
| mir_detect_script | String | ||||
| data_ip_uuid | String | B8166905-411E-B2CD-A742-77B1346D8E84 | |||
| bk_file_crypt | Number | 0 | |||
| mir_detect_src_script | String | ||||
| traversing_sync | Number | 1 | |||
| encrypt | Number | 1 | |||
| compress_switch | Number | 1 | |||
| rep_uuid | String | B8166905-411E-B2CD-A742-77B1346D8E84 | |||
| buf_in_bk | Number | 1 | |||
| rep_oph_policy | Number | 0 | |||
| rep_oph_path | String | ||||
| rep_oph_switch | Number | 1 | |||
| src_cfs_uuid | String | ||||
| tgt_cfs_uuid | String | ||||
| src_filesystem_id | String | ||||
| tgt_filesystem_id | String | ||||
| proxy_uuid | String | ||||
| mirr_hash_type | Number | 1 | |||
| random_str | String | 随机字符串 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | @guid | |||
| uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 |
CFS - 获取详情
SDK方法名：describeCfsBackup；
URL
/cfs_backup/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| cfs_backup | Object | ||||
| mirr_sync_attr | Number | 1 | |||
| oph_path | String | E:\test4\ | |||
| rep_name | String | rep_backup | |||
| bk_path_policy | Number | 1 | |||
| mirr_open_type | Number | 0 | |||
| compress | Number | 0 | |||
| encrypt_switch | Number | 0 | |||
| auto_start | Number | 1 | |||
| wk_path | Array | ["E:\test\"] | |||
| band_width | String | ||||
| mirr_sync_flag | Number | 0 | |||
| bk_path | Array | ["E:\test2\"] | |||
| wk_uuid | String | B8566905-411E-B2CD-A742-77B1346D8E84 | |||
| mirr_file_check | Number | 0 | |||
| rep_type | Number | 0 | |||
| file_type_filter_switch | Number | 0 | |||
| file_type_filter | String | ||||
| oph_policy | Number | 2 | |||
| mirr_skip | String | 0 | |||
| bk_uuid | String | B8566905-411E-B2CD-A742-77B1346D8E84 | |||
| excl_path | Array | ||||
| mirr_sched | String | ||||
| bkup_one_time | Number | 1515568566 | |||
| mirr_sched_switch | Number | 0 | |||
| ct_name_type | Number | 0 | |||
| ct_name_str1 | String | ||||
| ct_name_str2 | String | ||||
| ct_name_str3 | String | ||||
| ct_name_str4 | String | ||||
| thread_num | Number | 0 | |||
| latency_threshold | Number | 1 | |||
| mir_detect_script | String | ||||
| data_ip_uuid | String | B8166905-411E-B2CD-A742-77B1346D8E84 | |||
| bk_file_crypt | Number | 0 | |||
| mir_detect_src_script | String | ||||
| traversing_sync | Number | 1 | |||
| encrypt | Number | 1 | |||
| compress_switch | Number | 1 | |||
| rep_uuid | String | B8166905-411E-B2CD-A742-77B1346D8E84 | |||
| buf_in_bk | Number | 1 | |||
| rep_oph_policy | Number | 0 | |||
| rep_oph_path | String | ||||
| rep_oph_switch | Number | 1 | |||
| src_cfs_uuid | String | ||||
| tgt_cfs_uuid | String | ||||
| src_filesystem_id | String | ||||
| tgt_filesystem_id | String | ||||
| proxy_uuid | String | ||||
| mirr_hash_type | Number | 1 | |||
| src_zone_id | String | ||||
| tgt_zone_id | String |
CFS - 获取列表
SDK方法名：listCfsBackup;
URL
/cfs_backup
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 分页- 页数 | |||
| limit | Number | 分页 - 每页条数 | |||
| search_field | String | src_cfs_name：源集群名称过滤； tgt_cfs_name：目标集群名称过滤 | |||
| search_value | String | 过滤值 | |||
| where_args[move_status] | String | 迁移状态过滤： NO_MOVE：无需迁移； WAITING_MOVE：等待迁移； MOVING：迁移中； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| info_list | Array | ||||
| rep_uuid | String | 规则uuid | @pick(["EFB53F11-7BA2-2001-3418-85865EA58E47", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E3"]) | ||
| rep_name | String | 规则名称 | testbak | ||
| src_cfs_uuid | String | 源集群uuid | |||
| src_cfs_name | String | 源集群名称 | |||
| src_filesystem_id | String | 源文件系统id | |||
| src_zone_id | String | 源可用区id | |||
| wk_uuid | String | 工作机uuid | |||
| wk_node_name | String | 工作机名称 | |||
| tgt_cfs_uuid | String | 目标集群uuid | |||
| tgt_cfs_name | String | 目标集群名称 | |||
| tgt_filesystem_id | String | 目标文件系统id | |||
| tgt_zone_id | String | 目标可用区id | |||
| bk_uuid | String | 灾备机uuid | |||
| bk_node_name | String | 灾备机名称 | |||
| user_uuid | String | 所有者uuid | |||
| username | String | 所有者名称 | |||
| is_biz_admin | String | 当前用户是否拥有业务管理员角色： 0：否； 1：是； | |||
| can_up | Number | 允许更新： 0：否； 1：是； | |||
| can_op | Number | 允许操作： 0：否； 1：是； | |||
| can_del | Number | 允许删除： 0：否； 1：是； | |||
| cmp_switch | Number | 比较同步 - 开关： 0：关； 1：开； | |||
| cmp_type | Number | 比较同步 - 任务类型： 0：只比较； 1：比较并同步； | |||
| mirr_skip | Number | 镜像设置 -跳过镜像： 0：正常镜像； 1：直接进入复制状态； 2：仅同步目录； | |||
| total | Number | 100 | |||
| message | String | ||||
| code | Number | 0 |
CFS - 删除
SDK方法名：deleteCfsBackup；
URL
/cfs_backup
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuids | Array | 是 | 规则uuid数组 | ||
| force | Number | 强制删除： 0：否； 1：是； | |||
| del_policy | Number | 是否删除备份数据 | |||
| recycle | 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 | BC92C981-D637-AC10-7CB0-450504DF8A3C | |||
| rep_name | String | test1 | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rep_uuid | String | BA92C981-D637-AC10-7CB0-450504DF8A3C | |||
| rep_name | String | test2 |
CFS - 操作
SDK方法名：{operate}CfsBackup;
URL
/cfs_backup/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuids | Array | 规则uuid数组 | |||
| operate | String | start：启动； stop：停止； start_sync：启动，同步任务； stop_sync：停止，同步任务； move：迁移； |
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 | BC92C981-D637-AC10-7CB0-450504DF8A3C | |||
| rep_name | String | test1 | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rep_uuid | String | BA92C981-D637-AC10-7CB0-450504DF8A3C | |||
| rep_name | String | test2 |
CFS - 获取状态
SDK方法名：listCfsBackupStatus；
URL
/cfs_backup/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuids | Array | 规则uuid数组 | |||
| force_refresh | String | 强制刷新： 0：否； 1：是； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| status | Array | ||||
| rep_uuid | String | 规则uuid | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | ||
| status | String | 状态 | STOP | ||
| latency | Number | 复制延迟 | 10 | ||
| file_total | String | 1 | |||
| latency_threshold | Number | 10 | |||
| progress | String | 60 | |||
| blist | String | ||||
| file_current | String | ||||
| move_status | String | 迁移状态： NO_MOVE：无需迁移； WAITING_MOVE：等待迁移； MOVING：迁移中； EXCEPTION_MOVE：迁移异常； | |||
| need_fresh | Number | 有自动迁移的规则，需要刷新页面 | |||
| wk_uuid | String | ||||
| wk_node_name | String | ||||
| wk_config_ip | String | ||||
| wk_ip | String | ||||
| wk_os_type | String | ||||
| bk_uuid | String | ||||
| bk_node_name | String | ||||
| bk_config_ip | String | ||||
| bk_ip | String | ||||
| bk_os_type | String |
CFS - 获取同步任务状态
SDK方法名：listCfsBackupSyncStatus；
URL
/cfs_backup/sync_status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuid | Array | 规则uuid数组 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| status | Array | ||||
| rep_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
| status | String | STOP | |||
| file_total | String | 1 | |||
| progress | String | 60 | |||
| blist | String | ||||
| file_current | String | ||||
| finish_in | String |
获取节点等待迁移规则数
SDK方法名：getWatingMoveNumber；
URL
/cfs_backup/waiting_move_number
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| node_uuid | String | 节点uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| number | Number | 节点关联的等待迁移的规则数量 |
CFS - 获取历史规则列表
SDK方法名：listCfsBackupHistory；
URL
/cfs_backup/list_history
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rep_uuid | String | 规则uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| info_list | Array | ||||
| history_id | Number | 规则历史id | |||
| rep_uuid | String | 复制规则uuid | |||
| history_uuid | String | 历史记录uuid | |||
| create_time | Number | 规则创建时间，unix时间戳 | |||
| delete_time | Number | 规则删除时间，unix时间戳，可以为空 | |||
| src_filesystem_id | String | 源文件系统id | |||
| wk_uuid | String | 工作机uuid | |||
| wk_node_name | String | 工作机名称 | |||
| tgt_filesystem_id | String | 目标文件系统id | |||
| bk_uuid | String | 灾备机uuid | |||
| bk_node_name | String | 灾备机名称 | |||
| total | Number | 总数 |