整机恢复
August 1, 2024About 6 min
整机恢复
SDK类名：/fspRecoveryRule/fspRecoveryRule;
整机恢复 - 列表
SDK方法名：listFspRecoveryRule；
URL
/vers/v3/fsp/recovery_rule
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 页数 | 1 | ||
| limit | Number | 条数 | 1 | ||
| like_args[rule_name] | String | 模糊搜索：任务名称 | |||
| filter_by_biz_grp | Number | 根据业务组过滤开关：1 | 1 | ||
| where_args[rule_uuid] | String | 根据业务组过滤：业务组UUID | |||
| like_args[wk_node_name] | String | 模糊搜索：客户端名称 | |||
| like_args[wk_hostname] | String | 模糊搜索：客户端主机名 | |||
| status | String | 状态过滤： DISABLE：禁用； FINISH：完成； SCHEDULING：调度中； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | ||||
| can_del | Number | 1 | |||
| can_up | Number | 1 | |||
| can_op | Number | 1 | |||
| is_biz_admin | Number | 1 | |||
| rule_name | String | @first | |||
| rule_uuid | String | 24B3A55B-D338-4974-83D5-A6C4849AC712 | |||
| user_name | String | user-@first | |||
| user_uuid | String | ||||
| rule_type | String | ||||
| bk_set_id | String | set-@increment | |||
| wk_node_name | String | 目标客户端名称 | client-@first | ||
| src_node_name | String | 源客户端名称 | server-@first | ||
| bk_start_tm | String | @natural(100000, 10000000000) | |||
| bk_end_tm | String | @natural(100000, 10000000000) | |||
| total | Number | 24 |
整机恢复 - 新建
SDK方法名：createFspRecoveryRule；
URL
/vers/v3/fsp/recovery_rule
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | 基本参数 - 规则名称 | |||
| rule_type | Number | 基本参数 - 规则类型 0 - 表示块设备 | |||
| auto_start | Number | 基本参数 - 启动类型 0：预约启动； 1：立即启动； | |||
| start_time | Number | 基本设置 - 预约启动unix时间戳 | |||
| priority | Number | 基本参数 - 优先级：0~99999 | |||
| bk_set_uuid | String | 备份集 - 备份集uuid | |||
| backup_chain_policy | Number | 备份集 - 备份链选择策略， 1: 恢复时，首先选择主副本，当主副本不可用时，按照副本序号从小到大依次选择 2: 恢复时，首先选择和指定副本的存储单元相同的副本，然后是同存储单元组的，如果没有找到合适 的备份集，则恢复失败 3: 恢复时，首先选择和指定副本的存储单元相同的副本，然后是同存储单元组的，最后是同业务组的， 如果没有找到合适的备份集，则恢复失败 | |||
| wk_uuid | String | 恢复目标 - 恢复内容 - 目标客户端 | |||
| wk_path | Array | 恢复目标 - 恢复内容 - 源块设备 | |||
| bk_path | Array | 恢复目标 - 恢复内容 - 目标块设备 | |||
| bios_convert | Number | 恢复目标 - 恢复参数 - 启动引导模式转换 0 - 关；1 - 开 | |||
| bios_type | Number | 恢复目标 - 恢复参数 - 目标主机引导模式 0 - 默认 1 - bios 2 - uefi | |||
| driver_url | String | 恢复目标 - 恢复参数 - 目标机驱动 | |||
| compress_switch | Number | 参数配置 - 传输压缩开关： 0：关； 1：开； | |||
| compress | Number | 参数配置 - 传输压缩： 1：极速； 2：普通； 3：快速； 4：均衡； | |||
| encrypt_switch | Number | 参数配置 - 传输加密开关： 0：关； 1：开； | |||
| encrypt | Number | 参数配置 - 传输加密： 1：AES； 2：SM4； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
整机恢复 - 单个
SDK方法名：listFspRecoveryRule；
URL
/vers/v3/fsp/recovery_rule/:uuid([A-F0-9]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| fspRecoveryRule | Object | ||||
| rule_name | String | ||||
| rule_uuid | String | ||||
| rule_type | String | ||||
| random_str | String | ||||
| create_time | String | ||||
| auto_start | Number | 1 | |||
| priority | Number | 1 | |||
| bk_set_uuid | String | ||||
| backup_chain_policy | Number | 1 | |||
| wk_uuid | String | ||||
| wk_path | String | ||||
| bk_path | String | ||||
| bios_convert | Number | 1 | |||
| bios_type | Number | 1 | |||
| driver_url | String | ||||
| compress_switch | Number | 1 | |||
| compress | Number | 1 | |||
| encrypt_switch | Number | 1 | |||
| encrypt | Number | 1 | |||
| start_time | Number | 1 |
整机恢复 - 删除
SDK方法名：deleteFspRecoveryRule；
URL
/vers/v3/fsp/recovery_rule
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | ||||
| force | Number | 1 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [-1] 找不到节点 | |||
| rule_uuid | String | @uuid | |||
| rule_name | String | @name | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rule_uuid | String | @uuid | |||
| rule_name | String | @name | |||
| ret | Number | 200 |
整机恢复 - 修改
SDK方法名：modifyFspRecoveryRule；
URL
/vers/v3/fsp/recovery_rule/:uuid([A-F0-9]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | ||||
| rule_uuid | String | ||||
| rule_type | String | ||||
| random_str | String | ||||
| create_time | String | ||||
| auto_start | Number | 1 | |||
| priority | Number | 1 | |||
| bk_set_uuid | String | ||||
| backup_chain_policy | Number | 1 | |||
| wk_uuid | String | ||||
| wk_path | String | ||||
| bk_path | String | ||||
| bios_convert | Number | 1 | |||
| bios_type | Number | 1 | |||
| driver_url | String | ||||
| compress_switch | Number | 1 | |||
| compress | Number | 1 | |||
| encrypt_switch | Number | 1 | |||
| encrypt | Number | 1 | |||
| start_time | Number | 1 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
整机恢复 - 操作
SDK方法名：operateFspRecoveryRule；
URL
/vers/v3/fsp/recovery_rule/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 开始：start； 停止：stop； | |||
| rule_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [-1] 找不到节点 | |||
| rule_uuid | String | @uuid | |||
| rule_name | String | @name | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rule_uuid | String | @uuid | |||
| rule_name | String | @name | |||
| ret | Number | 200 |
整机恢复 - 状态
SDK方法名：listFspRecoveryRuleStatus；
URL
/vers/v3/fsp/recovery_rule/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| status|2 | Array | ||||
| rule_uuid | String | 24B3A55B-D338-4974-83D5-A6C4849AC712 | |||
| status | String | @pick('FINISH', 'STOP') | |||
| rc_time | String | 2024-04-14 22:03:56 |
整机恢复 - 获取BIOS类型
SDK方法名：getFspRecoveryRuleBiosType;
URL
/vers/v3/fsp/recovery_rule/bios_type
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| device_list | Array | 是 | 备机上存储的块设备列表 | ||
| node_uuid | String | 灾备机uuid，从备份集中取bk_uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| bios_type | String | ||||
| msg | String | ||||
| ret | Number | 200 |
整机恢复 - 目标机驱动URL列表
SDK方法名：listFspRecoveryRuleDriverListUrl;
URL
/vers/v3/fsp/recovery_rule/driver_url_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| driver_url_list | Array | ["https://172.20.66.249:58086/drivers/drivers_dell730_windows2016_20221031.zip"] |