虚拟化
June 24, 2022About 54 min
虚拟化
SDK类名：/vp/VirtualizationSupport;
Dashboard - 虚机规则 成功率
统计报表
SDK方法名：describeVpRuleRate
URL
/dashboard/vp_rule
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuid | String | 否 | 可选，用虚机规则过滤 | ||
| type | String | 否 | 可选，用任务类型过滤， 'VP_BK'： 备份规则， 'VP_RC'：恢复规则， 'VP_MV'：迁移规则， 'VP_PT'：复制规则， 'VP_OR'：演练规则， | I2VP_BK | |
| wk_uuid | String | 否 | 可选，用虚拟平台过滤 | F28BA5A6-4FF9-E596-4371-1ED203D45143 | |
| mode | String | 否 | 必传，显示近 week | month | year 的统计 | month |
| group_uuid | String | 否 | 可选， 用组规则过滤 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 | ||
| success_num|1-100 | Number | 否 | 当前条件下总... | 23 | |
| failed_num|1-100 | Number | 否 | 当前条件下总失败数 | ||
| total_num|1-100 | Number | 否 | 当前条件下总... | 2 | |
| trans_data_num | String | 否 | 当前条件下总... | 1.27MB | |
| unread_err_num|0-100 | Number | 否 | 当前条件下总... | 2 | |
| info_list | Array | 否 | 30 | ||
| time | String | 否 | 月/日 | 11-26 | +1 |
| success_num|0-100 | Number | 否 | 成功任务数量 | 23 | |
| failed_num|1-100 | String | 否 | |||
| total_num|0-100 | Number | 否 | 总任务数量 | 2 | |
| trans_data_num | String | 否 | 传输数据大小 | 1.27MB | |
| unread_err_num | Number | 否 | 未查看错误数 | 2 | |
| all_success_num|1-100 | Number | 否 | 总... | ||
| all_failed_num|1-100 | Number | 否 | 总失败数 | ||
| all_total_num|1-100 | Number | 否 | 总... | ||
| all_trans_data_num | String | 否 | 总... | 9.00 GB | |
| all_unread_err_num|0-100 | Number | 否 | 总... |
Dashboard - 虚机 保护率
统计报表
SDK方法名：describeVmProtectRate
URL
/dashboard/vp_vm
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| vp_uuid | String | 否 | 可选（不传获取所有） | F28BA5A6-4FF9-E596-4371-1ED203D45143 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 | ||
| vm_total | Number | 否 | 总... | 21 | |
| vm_protected | Number | 否 | 总... | 12 | |
| info_list | Array | 否 | |||
| vp_name | String | 否 | 虚拟平台名称 | daaaa | |
| vm_total | Number | 否 | 虚机总量 | 21 | |
| vm_protected | Number | 否 | 虚机总量 | 12 | |
| vp_uuid | String | 否 | 虚拟平台uuid | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 |
------- 虚机备份 -------
URL
/dash/vp_backup
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
虚机备份 - 新建
添加备份规则
SDK方法名：createVpBackup
URL
/vp/backup
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_type | Number | 否 | 规则类型：0：普通规则；10：模板； | 0 | |
| rule_name | String | 否 | *必填 规则名称 | vp_bk cky | |
| vp_uuid | String | 否 | 虚拟平台uuid（普通任务必填，模板传空串） | C6335F62-2565-1957-4BB9-587F2FF46B00 | |
| agent_uuid | String | 虚拟平台为openstack时传，虚拟平台代理节点uuid | |||
| source_region_id | String | 区域ID（云平台） | |||
| source_project_id | String | 项目ID（云平台） | |||
| vm_list | Array | 否 | 虚机信息（普通任务必填，模板传空数组） | ||
| vm_name | String | 否 | 虚机名称 | 测试5 | |
| vm_ref | String | 否 | 虚机id | vm-10811 | |
| disk_list | Array | 否 | 磁盘信息 | ||
| id | String | 否 | |||
| disk_dir | String | 否 | |||
| disk_name | String | 否 | |||
| size | String | ||||
| datastore | String | ||||
| is_ignored | Number | 否 | 选中为0，不选为1 | ||
| datastore_type | String | 存储类型（Fusion storage显示） | |||
| new_vm_name | String | 否 | 新虚机名称 | 虚机名称_2020-04-29 | |
| scripts_type | Number | 否 | 开启验证时： (*必填)脚本验证的方式，0表示验证ping方法验证，1表示tcp端口验证测试，2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0 | ||
| scripts | String | 否 | 开启验证时： 验证内容 | ||
| cpu | String | 否 | 开启验证时： cpu数 | ||
| core_per_sock | String | 否 | 开启验证时： 单个cpu核数 | ||
| mem_mb | String | 否 | 开启验证时： 内存大小 | ||
| os_type | Number | 否 | 开启验证时： 操作系统： 0：linux； 1：windows | ||
| vm_uuid | String | 虚机uuid标记，从虚机列表获取，可以为null | null | ||
| is_set | Number | 是否设置了自定义设置： 0：否； 1：是； | 0 | ||
| biz_grp_list | Array | 否 | 业务分组：组uuid数组 | ||
| bk_uuid | String | 否 | 备机uuid | 67E33CDB-D75B-15B3-367D-50C764F5A26F | |
| bk_type | Number | 备份存储类型： 0：文件系统； 1：对象存储； | 0 | ||
| bk_path | String | 否 | *必填 备份路径 | E:\vp_bk5\ | |
| sto_uuid | String | 对象存储uuid | |||
| bucket | String | 对象桶（name） | |||
| bucket_path | String | 桶路径 | |||
| quick_back | Number | 否 | 快速备份；1：开；0：关； | 1 | |
| lan_free | Number | 否 | lan free 传输；31：开；23：关； | 23 | |
| del_bkup_data | Number | 否 | 删除备份数据；1：开；0：关； | 0 | |
| quiet_snap | Number | 否 | 静默快照；1：开；0：关； | 0 | |
| mem_snap | Number | 否 | 内存快照；0关1开 | 0 | |
| instant_recovery | Number | 否 | 是否可以瞬时恢复，0关1开 | ||
| src_trans_mode | Number | 源平台数据传输模式： 1：nbd； 2：nbdssl； 4：hotadd； 8：san； 31：auto； | 31 | ||
| bkup_policy | Number | 否 | 备份策略，0：一次性（定时），1：周期（循环）； | 1 | |
| bkup_one_time | Number | 否 | 备份策略 - 一次性，执行时间，格式：linux时间戳，非一次型传0 | 1546831899 | |
| bkup_schedule | Array | 否 | 备份策略 - 周期任务；非周期任务则传空数组； | ||
| limit | Number | 否 | 数据保留期限（天） | 3 | |
| sched_day | Array | 否 | 备份策略 - 周期任务 - 哪几天，num数组； 【每月】、【每周】专用参数；取值：每月：1-31；每周：0-6（周日-周六） | [1, 2, 3] | |
| sched_time | Array | 否 | 备份策略 - 周期任务 - 运行时间；str数组；取值格式HH:mm | ["00:00"] | |
| sched_every | Number | 否 | 备份策略 - 周期任务 - 策略类型；0：每天；1：每周：2：每月； | 0 | |
| bkup_type | Number | 否 | 备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异，3：合成 | 0 | |
| band_width | String | 否 | 带宽控制，默认为空不启用 格式： 星期几:时间点-带宽;时间点-带宽,星期几:时间点-带宽;时间点-带宽；星期：0-6：日-六；时间点：0-23（0代表0点-0：59分）；带宽：0-1000，单位8k；成品串实例： | -1 | |
| random_str | String | 否 | 新建不传，sdk测试用 | 11111111-1111-1111-1111-111111111111 | |
| add_drill | Number | 否 | 是否开启认证： 0：否， 1：是， 默认否 | ||
| auto | Number | 否 | 开启验证时必传： 自动验证： 自动：1，手动：0； | 0 | |
| drill_plat_uuid | String | 否 | 开启验证时传： 目标平台的vp_uuid | ||
| data_ip_uuid | String | 数据地址 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | ||
| cred_uuid | String | 凭据uuid | |||
| trans_type | String | 数据传输方式，FTP，SCP | |||
| ftp_path | String | trans_type为FTP时为必填项 | |||
| data_verify | Number | 是否开启数据校验数据校验 | 0 | ||
| compress | Number | 否 | 备端数据压缩： 0：关； 1：开； | 0 | |
| encrypt_switch | Number | 备端数据加密： 0：关； 1：开； | |||
| encrypt_type | Number | 备端数据加密方式 1：aes， 2：sm4 | |||
| encrypt_key | String | 备端加密密钥。 | |||
| transfer_compression | Number | 传输压缩： 0：关； 1：开； | 0 | ||
| transfer_encrypt | Number | 传输加密： 0：关； 1：开； | 0 | ||
| is_limit_backuptime | Number | 是否开启指定范围 | 0 | ||
| backup_times | Array | 备份窗口时间。不开启时为空 | |||
| day_of_week | Array | 星期日 0 星期一 1 星期二 。。。 | [] | ||
| begin_time | String | 备份时间段开始时间 eg. 12:20 | 00:00 | ||
| end_time | String | 备份时间段结束时间 eg. 13:35 | 00:00 | ||
| consolidate_switch | Number | 磁盘整合开关： 0：关； 1：开 | 0 | ||
| consolidate_disks_time | String | 磁盘整合时间 | |||
| fail_retry | Number | 失败重试开关: 0：关；1：开 | |||
| retry_times | Number | 失败重试次数。0-5的整数。默认0，不进行重试； | |||
| retry_interval | Number | 失败重试的间隔，单位分钟。默认0,无间隔；0-30的整数。 | |||
| concurrent_disk_threads | Number | 磁盘传输并发数 默认值 2 值为 1 2 3 4 | |||
| backup_method | Number | 备份方式： 平台类型为cas（vp_type=7）时必传： 0 : 基于平台接口 1：基于平台主机代理 | 0 | ||
| auto_discovery | Number | 是否开启自动发现0否1是 | 0 | ||
| match_policy | Object | 虚机自动发现，匹配规则 | |||
| vm_name | Array | 虚机名称 | |||
| type | String | 包含：include； 排除：exclude； | |||
| value | String | 匹配词 | |||
| label | String | ||||
| location | Array | 物理位置 | |||
| type | String | 数据中心：Datacenter 集群：ClusterComputeResource 主机：HostSystem 数据存储：Datastore | |||
| value | String | 值（id标识） | |||
| label | String | 名称等 | |||
| folder | Array | 逻辑位置 | |||
| type | String | 文件夹：Folder；（默认） | |||
| value | String | 值（路径） | |||
| label | String | ||||
| is_fusion_storage | Number | 是否fusion storage: 0：否； 1：是； | 0 | ||
| winstack_pool_id | String | winstack池ID | |||
| winstack_host_id | String | winstack主机ID |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| message | String | 否 | , 错误信息提示 | ||
| code | Number | 否 | @mock=0 | 0 | |
| success_list | Array | 否 | 内容类似 fail_list | ||
| fail_list | Array | 否 | |||
| code | String | 否 | 成功返回0，规则冲突返回6077 | ||
| message | String | 否 | |||
| rule_uuid | String | 否 | 规则的uuid | ||
| vm_name | String | 否 | 虚机名称 | ||
| conflict_rule_name | String | 否 | 冲突的规则名称 | ||
| conflict_vm_name | String | 否 | 冲突的虚机名称 | ||
| conflict_username | String | 冲突用户名 | |||
| msg | String | 否 | , 错误信息 | ||
| ret | Number | 否 | @mock=200, http code | 200 |
虚机备份 - 修改
添加备份规则；URL参数为 group_uuid；
接口入参和新建一样，修改规则为新建完整规则参数，模板则去掉 vp_uuid 和 vm_list；
SDK方法名：modifyVpBackup
URL
/vp/backup/group/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| msg | String | 否 | , 错误信息 | ||
| ret | Number | 否 | @mock=200, http code | 200 |
虚机备份 - 获取单个
查看备份规则，URL参数为 rule_uuid
SDK方法名：describeVpBackup
URL
/vp/backup/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| message | String | 否 | |||
| code | Number | 否 | 0 | ||
| vp_backup | Object | 否 | |||
| del_bkup_data | Number | 否 | 1 | ||
| quiet_snap | Number | 否 | 1 | ||
| quick_back | Number | 否 | 1 | ||
| vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| vp_name | String | 否 | vp_name | ||
| vp_type | Number | 否 | |||
| bk_path | String | 否 | C:\test\ | ||
| bk_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| agent_uuid | String | 代理节点uuid | |||
| source_region_id | String | 区域ID（云平台） | |||
| source_project_id | String | 项目ID（云平台） | |||
| lan_free | Number | 否 | 1 | ||
| rule_name | String | 否 | temp | ||
| bkup_policy | Number | 否 | 0 | ||
| bkup_one_time | Number | 否 | 1515568566 | ||
| bkup_schedule | Array | 否 | |||
| limit | Number | 否 | 3 | ||
| sched_day | Array | 否 | [1,2,3] | ||
| sched_time | Array | 否 | ["00:00"] | ||
| sched_every | Number | 否 | 0 | ||
| bkup_type | Number | 否 | 0 | ||
| create_time | String | 否 | 1515568566 | ||
| rule_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| random_str | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| username | String | 否 | Joseph Johnson | ||
| user_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| bk_node_name | String | 否 | |||
| vm_name | String | 否 | |||
| vm_ref | String | 否 | |||
| data_ip_uuid | String | C02B76DB-EBE8-E029-B645-072B2E1A7461 | |||
| backup_method | Number | cas平台备份方式 | 0 | ||
| total | Number | 否 | 1 | ||
| ret | Number | 否 | 200 | ||
| msg | String | 否 |
虚机备份 - 获取单个（组）
查看备份规则，URL参数为 group_uuid
SDK方法名：describeVpBackupGroup
URL
/vp/backup/group/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| message | String | 否 | |||
| code | Number | 否 | 0 | ||
| vp_backup | Object | 否 | |||
| del_bkup_data | Number | 否 | 1 | ||
| quiet_snap | Number | 否 | 1 | ||
| quick_back | Number | 否 | 1 | ||
| vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| vp_name | String | 否 | 平台名称 | vp_name | |
| vp_type | Number | 否 | |||
| bk_path | String | 否 | C:\test\ | ||
| bk_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| lan_free | Number | 否 | 1 | ||
| rule_name | String | 否 | temp | ||
| bkup_policy | Number | 否 | 1 | ||
| bkup_one_time | Number | 否 | 1515568566 | ||
| bkup_schedule | Array | 否 | |||
| limit | Number | 否 | 3 | ||
| sched_day | Array | 否 | [1,2,3] | ||
| sched_time | Array | 否 | ["00:00"] | ||
| sched_every | Number | 否 | 0 | ||
| bkup_type | Number | 否 | 0 | ||
| create_time | String | 否 | 1515568566 | ||
| rule_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| random_str | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| username | String | 否 | Joseph Johnson | ||
| user_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| bk_node_name | String | 否 | 备机名 | ||
| group_uuid | String | 否 | @guid | ||
| vm_list | Array | 否 | |||
| rule_uuid | String | 否 | 虚机对应单个规则uuid | ||
| vm_name | String | 否 | @name | ||
| vm_ref | String | 否 | 110 | ||
| drill_uuid | String | 否 | 存在演练时返回： 演练规则uuid | ||
| new_vm_name | String | 否 | 存在对应演练规则时返回： 新虚机名称 | ||
| scripts | String | 否 | 存在对应演练规则时返回 | ||
| scripts_type | Number | 否 | 存在对应演练规则时返回: 脚本验证的方式，0表示验证ping方法验证，1表示tcp端口验证测试，2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0 | ||
| cpu | String | 否 | 存在对应演练规则时返回: cpu数 | ||
| core_per_sock | String | 否 | 存在对应演练规则时返回: 单个cpu核数 | ||
| mem_mb | String | 否 | 存在对应演练规则时返回: 内存大小 | ||
| os_type | Number | 否 | 存在对应演练规则时返回: 操作系统： 0：linux； 1：windows | ||
| band_width | String | 否 | -1 | ||
| add_drill | Number | 否 | 是否开启验证，0否，1是 | ||
| auto | Number | 否 | 存在对应演练规则时返回: 自动演练：自动：1，手动：0；默认为0 | ||
| drill_plat_uuid | String | 否 | 开启验证时：演练平台uuid | ||
| agent_uuid | String | 代理节点uuid | |||
| source_region_id | String | 区域ID（云平台） | |||
| source_project_id | String | 项目ID（云平台） | |||
| source_node_region_id | String | 节点连表查到的字段，防止旧规则不存在source_region_id | |||
| source_node_project_id | String | 节点连表查到的字段，防止旧规则不存在source_project_id | |||
| total | Number | 否 | 1 | ||
| ret | Number | 否 | 200 | ||
| msg | String | 否 |
虚机备份 - 列表
获取备份规则列表；获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；
SDK方法名：listVpBackup
URL
/vp/backup
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 否 | 可选 | 1 | |
| limit | Number | 否 | 可选 | 10 | |
| type | Number | 否 | 规则类型：0：普通规则；10：模板； | 0 | |
| status | String | 可选，总览页面跳转时按照状态过滤时需要 REPLICATION MAINTAIN WAIT FINISH STOP UNKNOWN |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| info_list | Array | 否 | 3 | ||
| bk_node_name | String | 否 | 备机名称 | @name | |
| group_uuid | String | 否 | @guid | ||
| username | String | 否 | @name | ||
| rule_name | String | 否 | @name | ||
| rule_uuid | String | 否 | @guid | ||
| vp_uuid | String | 否 | @guid | ||
| vp_type | String | 否 | |||
| vp_name | String | 否 | 平台名称 | @name | |
| vm_name | String | 否 | @name | ||
| bk_uuid | String | 否 | @guid | ||
| bk_type | Number | 0 | |||
| bk_path | String | 否 | /temp/ | ||
| sto_uuid | String | ||||
| bucket | String | ||||
| bucket_path | String | ||||
| last_result | Object | 否 | 上次执行结果详情，内容同统计报表 | ||
| last_success_result | Object | 否 | 上次执行成功结果详情，内容同统计报表 | ||
| vp_config_addr | String | 源平台管理地址 | |||
| vp_config_port | String | 源平台管理端口 | |||
| can_m | Boolean | 是否支持合成备份 | false | ||
| auto_discovery | Number | 是否开启自动发现0否1是 | 0 | ||
| can_op | Number | 1 | |||
| can_up | Number | ||||
| can_del | Number | 1 | |||
| can_start | Number | ||||
| can_stop | Number | ||||
| can_recovery | Number | ||||
| can_failover | Number | ||||
| can_failback | Number | ||||
| message | String | 否 | |||
| total | Number | 否 | 1 | ||
| ret | Number | 否 | 200 | ||
| msg | String | 否 |
虚机备份 - 列表（组）
获取备份规则组列表；
逻辑：是在【获取列表】基础上，融合同组规则，在规则上加入vm_list 数组，其中有 rule_uuid；
获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；
SDK方法名：listVpBackupGroup
URL
/vp/backup/group
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 否 | 可选 | 1 | |
| limit | Number | 否 | 可选 | 10 | |
| type | Number | 否 | 规则类型：0：普通规则；10：模板； | 0 | |
| where_args[bk_path] | String | 否 | (RC) 获取 bk_path 为 H:\tmp\ 的规则组； | H:\vp_bk5\ |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| message | String | 否 | |||
| code | Number | 否 | 0 | ||
| info_list | Array | 否 | 2 | ||
| del_bkup_data | Number | 否 | 1 | ||
| quiet_snap | Number | 否 | 1 | ||
| quick_back | Number | 否 | 1 | ||
| vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| vp_name | String | 否 | vp_name | ||
| vp_type | String | 否 | |||
| bk_path | String | 否 | C:\test\ | ||
| bk_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| lan_free | Number | 否 | 1 | ||
| rule_name | String | 否 | temp | ||
| bkup_policy | Number | 否 | 0 | ||
| bkup_one_time | Number | 否 | 1515568566 | ||
| bkup_schedule | Array | 否 | |||
| limit | Number | 否 | 3 | ||
| sched_day | Array | 否 | [1,2,3] | ||
| sched_time | Array | 否 | ["00:00"] | ||
| sched_every | Number | 否 | 0 | ||
| bkup_type | Number | 否 | 0 | ||
| create_time | String | 否 | 1515568566 | ||
| rule_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| random_str | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| username | String | 否 | Joseph Johnson | ||
| user_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| bk_node_name | String | 否 | |||
| group_uuid | String | 否 | cCBEC2D3-B6FE-853F-33db-d292b2D62De1 | ||
| vm_list | Array | 否 | |||
| vm_name | String | 否 | Christopher Jackson | ||
| vm_ref | String | 否 | 110 | ||
| total | Number | 否 | 1 | ||
| ret | Number | 否 | 200 | ||
| msg | String | 否 |
虚机备份 - 状态
获取备份规则的状态
SDK方法名：listVpBackupStatus
URL
/vp/backup/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | ||
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | |||
| data | Object | 否 | |||
| count | String | 否 | 1 | ||
| message | String | 否 | |||
| code | Number | 否 | 0 | ||
| status | Array | 否 | 2 | ||
| status | String | 否 | stop,executing,idle,dead,finish,switch,unknown, | @pick(["STOP","EXECUTING","IDLE","DEAD","FINISH","SWITCH","UNKNOWN","VP_START","VP_CHECK","VP_CFG","VP_CBT"]) | |
| progress | Number | 否 | 0-100 | ||
| rule_uuid | String | 否 | @guid | ||
| last_result | Object | 否 | 上次执行结果详情，内容同统计报表 | ||
| last_success_result | Object | 否 | 上次执行成功结果详情，内容同统计报表 | ||
| ret | Number | 否 | 200 |
虚机备份 - 操作 启停
SDK方法名：
启动：startVpBackup;
停止：stopVpBackup;
URL
/vp/backup/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 否 | "start", "stop"，"start_immediately", 'auto_discovery', | ||
| rule_uuids | Array | 否 | 规则uuid列表 | [C6335F62-2565-1957-4BB9-587F2FF46B00] | |
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| bkup_type | String | 否 | 立即执行操作（start_immediately）必传，取值为，备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异，3：合成 | ||
| force | Number | “自动发现”参数，许可剩余数量不足时，是否强制添加： 0：否； 1：是； | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | , api content | ||
| message | String | 否 | , 错误信息提示 | ||
| code | Number | 否 | @mock=0 | 10110035 | |
| success_list | Array | ||||
| {$prefix}_uuid | String | rule_uuid、group_uuid | aaa | ||
| code | String | 0 | |||
| message | String | dsaf | |||
| rule_name | String | 规则名称 | adsf | ||
| vm_name | String | (单个规则，非文件恢复)虚机名称 | fadsf | ||
| fail_list | Array | ||||
| {$prefix}_uuid | String | rule_uuid、group_uuid | fads | ||
| code | String | fasfd | |||
| message | String | 错误讯息 | asfda | ||
| rule_name | String | 规则名称 | fssa | ||
| vm_name | String | (单个规则，非文件恢复)虚机名称 | fdsaf | ||
| ret | Number | 否 | @mock=200, http code | 200 | |
| msg | String | 否 | , 提示信息 |
虚机备份 - 删除
删除备份规则
SDK方法名：deleteVpBackup
URL
/vp/backup
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | ||
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| force | Number | 1 - 强制删除 0 - 非强制删除 | |||
| delete_bk_data | Number | 是否删除备份数据0,1 | 0 | ||
| recycle | Number | 是否添加到数据清理： 0：否； 1：是； | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| fail_list | Array | 否 | |||
| code | Number | 否 | 1 | ||
| message | String | 否 | |||
| rule_uuid | String | 否 | |||
| rule_name | String | 否 | |||
| success_list | Array | 否 | |||
| code | Number | 否 | 1 | ||
| message | String | 否 | |||
| rule_uuid | String | 否 | |||
| rule_name | String | 否 | |||
| ret | Number | 否 | 200 |
虚机备份 - 删除备份点
SDK方法名：deleteVpBackupPoint;
URL
/vp/backup/backup_data
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuid | String | 备份规则uuid | |||
| version_list | Array | 备份点uuid列表（目前只支持单个删除） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String |
------- 虚机恢复 -------
URL
/dash/vp_recovery
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
虚机恢复 - 新建
新建恢复规则
SDK方法名：createVpRecovery
URL
/vp/recovery
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | 否 | 规则名称 | testRC cky | |
| rule_type | Number | 否 | 恢复类型：0：普通；1：瞬时； | 0 | |
| api_type | String | 否 | API类型，如HostAgent、vcenter、Hyper-V | HostAgent | |
| bk_type | Number | 备份存储类型： 0：文件系统； 1：对象存储； | 0 | ||
| bk_path_view | String | 否 | 数据存放目录（与vm_list当中的bk_path所区分，仅用于页面展示） | H:\vp_bk5\testRC1_BAK_99_192.168.85.139 | |
| sto_uuid | String | 对象存储uuid | |||
| bucket | String | 对象桶（name） | |||
| bucket_path | String | 桶路径 | |||
| new_ds | String | 否 | 存储名称、Hyper-V：路径如 E:\hp\ | datastore1 | |
| new_hostname | String | 否 | 新主机名称 | localhost.localdomain | |
| new_dc | String | 否 | 数据中心 | ha-datacenter | |
| location | String | FusionCompute平台必选 恢复虚拟机所在的计算资源位置 | |||
| is_create | Number | 否 | 是否创建虚拟机 是 ：1 否：0 | 0 | |
| vp_uuid | String | 否 | 虚拟平台的uuid(源虚拟平台) | 928B88A6-CDBA-6F55-ADCB-15A8A935C9C2 | |
| bk_uuid | String | 否 | 备机节点uuid | 67E33CDB-D75B-15B3-367D-50C764F5A26F | |
| new_vp_uuid | String | 否 | 目标平台 | 928B88A6-CDBA-6F55-ADCB-15A8A935C9C2 | |
| agent_uuid | String | 目标平台为openstack，目标平台代理节点 | |||
| agent_data_ip_uuid | String | 目标平台代理节点数据地址 | |||
| target_region_id | String | 区域ID（云平台） | |||
| target_project_id | String | 项目ID（云平台） | |||
| lan_free | Number | 否 | 传输方式 | 23 | |
| dest_trans_mode | Number | 目标平台数据传输模式： 1：nbd； 2：nbdssl； 4：hotadd； 8：san； 31：auto； | 31 | ||
| auto_startup | Number | 否 | 自动开启虚机：0：关；1：开； | 0 | |
| new_dc_mor | String | 否 | 数据中心标识 | ha-datacenter | |
| new_ds_path | String | 否 | 工作目录：虚机平台是 hostagent 则为用户输入的目录，若虚拟平台是vcenter 则传 /，Hyper-V平台不用传 | / | |
| vm_list | Array | 否 | 虚拟机的数组 | ||
| vm_name | String | 否 | 测试5 | ||
| new_vm_name | String | 否 | 测试5 | ||
| vm_ref | String | 否 | 99 | ||
| bk_path | String | 否 | (组恢复时传)备份点信息列表返回的bk_path | ||
| ver_sig | String | 否 | 备份点id | A59DB76E-E33D-4E22-BB08-59723B1FC539 | |
| ver_time | String | 否 | 备份时间 | ||
| disk_list | Array | 否 | |||
| id | String | 否 | |||
| disk_path | String | 否 | / | ||
| disk_name | String | 否 | proxy gateway1.vmdk | ||
| is_same | Number | 否 | 1 | ||
| new_ds | String | 否 | datastore1 | ||
| boot_index | Number | 仅限源平台为vmware时使用 | 1 | ||
| disk_type | String | 磁盘类型，仅限openstack、hcs，默认为'' | '' | ||
| datastore_type | String | 存储类型（fusionstorage 显示） | |||
| networks | Array | 否 | 自定义 - 网卡 | ||
| source_network_name | String | 否 | 源端network_name | ||
| source_network_id | String | 否 | 源端network_id | ||
| mac_address | String | 否 | 源端mac地址 | ||
| keep_mac | Number | 否 | 1 | ||
| network_name | String | 否 | |||
| network_id | String | 否 | |||
| ip_address | String | 云平台固定ip地址 | |||
| cpu | Number | 否 | 处理器个数 | ||
| core_per_sock | Number | 否 | 处理器核心数 | ||
| mem_mb | Number | 否 | 内存 | ||
| dynamic_mem | Number | 否 | 是否动态内存，1表示动态内存，0表示非动态内存。 | ||
| flavor_id | String | 自定义 - 主机规格 | |||
| common_custom | Number | 是否开启自定义设置 - 通用 | 0 | ||
| disk_custom | Number | 是否开启自定义设置 - 磁盘 | 0 | ||
| encrypt_type | Number | 备端数据加密方式 0：不加密， 1：aes， 2：sm4 | 0 | ||
| encrypt_key | String | 当选择备份数据加密方式为aes加密时，密钥值。 | |||
| start_order | Number | 启动顺序，未开启时默认下发0 | 0 | ||
| biz_grp_list | Array | 否 | 业务分组，组uuid | ||
| group_recovery | Number | 否 | 是否组恢复；1：是；0：否 | 0 | |
| backup_rule_name | String | 否 | 对应备份规则的规则名称 | testRC1 | |
| band_width | String | 否 | 带宽 | -1 | |
| for_vp_file_rc | Number | 否 | 0否1是，是否用于VP文件级恢复 | 1 | |
| del_vm | Number | 否 | 是否删除虚机，默认为0；0：不删除，1：删除 | 1 | |
| network_id | String | 否 | 全局 - 网卡id | ||
| network_name | String | 否 | 全局 - 网卡name | ||
| ip_address | String | 云平台固定ip地址 | |||
| data_ip_uuid | String | 数据地址 | 928B88A6-CDBA-6F55-ADCB-15A8A935C9C1 | ||
| trans_type | String | 数据传输方式，FTP，SCP | |||
| cred_uuid | String | 凭据uuid | |||
| parent_flavor_id | String | 全局 - 主机规则 | |||
| concurrent_disk_threads | Number | 磁盘传输并发数 默认值 2 值为 1 2 3 4 | |||
| backup_method | Number | cas备份方式： 0：基于平台接口 1：基于平台主机代理 | 0 | ||
| is_start_order | Number | 是否设置开机启动顺序: 0：否； 1：是； | 0 | ||
| transfer_compression | Number | 传输压缩： 0：关； 1：开； | 0 | ||
| transfer_encrypt | Number | 传输加密： 0：关； 1：开； | 0 | ||
| is_fusion_storage | Number | 是否fusion store： 0：否； 1：是； | |||
| winstack_pool_id | String | ||||
| winstack_host_id | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| msg | String | 否 | |||
| ret | Number | 否 | 200 |
虚机恢复 - 获取单个 组
查看组规则信息；URL 参数：恢复规则组uuid；
SDK方法名：describeVpRecoveryGroup
URL
/vp/recovery/group/: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] 操作成功 | ||
| vp_recovery | Object | 否 | |||
| backup_rule_name | String | 否 | 9_21 | ||
| bk_node_name | String | 否 | N3_72.75 | ||
| group_uuid | String | 否 | F6FCFC4D-EE04-946B-56F2-A52E91AFD5A8 | ||
| rule_uuid | String | 否 | 8264AEDC-815B-0FA1-1FEE-F8B4FD15E1F1 | ||
| rule_name | String | 否 | 2221 | ||
| user_uuid | String | 否 | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | ||
| bk_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | ||
| vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| vp_name | String | 否 | 88.107 | ||
| vp_type | Number | 否 | |||
| new_vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| new_vp_name | String | 否 | 88.107 | ||
| new_vp_type | Number | 否 | |||
| new_dc | String | 否 | ha-datacenter | ||
| new_ds | String | 否 | datastore107（1） | ||
| new_dc_mor | String | 否 | ha-datacenter | ||
| bk_path | String | 否 | H:\vp_bk\111_BAK_119_192.168.88.107\ | ||
| new_ds_path | String | 否 | / | ||
| new_hostname | String | 否 | dev-esxi.6.6.6 | ||
| new_vm_name | String | 否 | chenky_vp_test | ||
| cpu | Number | 否 | 2 | ||
| core_per_sock | Number | 否 | 1 | ||
| mem_mb | Number | 否 | 3972 | ||
| mac | String | 否 | 3,00:50:56:96:73:51,5,4000,100,7,1,VM Network | ||
| automate | Number | 否 | 0 | ||
| api_type | String | 否 | HostAgent | ||
| is_create | Number | 否 | 0 | ||
| lan_free | Number | 否 | 23 | ||
| create_time | Number | 否 | 1537341291 | ||
| rule_type | Number | 否 | 1 | ||
| group_recovery | Number | 否 | 0 | ||
| random_str | String | 否 | F6FCFC4D-EE04-946B-56F2-A52E91AFD5A8 | ||
| mem_snap | Number | 否 | 0 | ||
| del_vm | Number | 否 | |||
| vm_list | Array | 否 | |||
| vm_name | String | 否 | chenky_vp_test | ||
| vm_ref | String | 否 | 119 | ||
| ver_sig | String | 否 | 199EDA68-3512-480A-8355-A0E9C2DA1587 | ||
| disk_list | Array | 否 | |||
| disk_name | String | 否 | chenky_vp_test.vmdk | ||
| disk_path | String | 否 | / | ||
| is_same | Number | 否 | 0 | ||
| new_ds | String | 否 | datastore107（1） | ||
| ver_time | String | 否 | 备份点时间 | ||
| data_ip_uuid | String | F1FCFC4D-EE04-946B-56F2-A52E91AFD5A8 | |||
| location | String | FusionCompute平台必选 恢复虚拟机所在的计算资源位置 | |||
| agent_uuid | String | ||||
| agent_data_ip_uuid | String | ||||
| target_region_id | String | ||||
| target_project_id | String | ||||
| target_node_region_id | String | ||||
| target_node_project_id | String |
虚机恢复 - 获取列表
获取规则列表
SDK方法名：listVpRecovery
URL
/vp/recovery
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| type | Number | 否 | 恢复类型：0：普通；1：瞬时； | 0 | |
| limit | Number | 否 | 可选 | 10 | |
| page | Number | 否 | 可选 | 1 | |
| where_args[rule_type] | Number | 0:普通恢复； 1:瞬时恢复； | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] success | ||
| info_list | Array | 否 | |||
| backup_rule_name | String | 否 | 9_21 | ||
| vp_name | String | 否 | 88.107 | ||
| bk_node_name | String | 否 | N3_72.75 | ||
| username | String | 否 | admin | ||
| create_time | Number | 否 | 1537341291 | ||
| rule_name | String | 否 | 2221 | ||
| rule_type | Number | 否 | 1 | ||
| ver_sig | String | 否 | 199EDA68-3512-480A-8355-A0E9C2DA1587 | ||
| vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| vm_name | String | 否 | chenky_vp_test | ||
| vp_type | Number | 否 | |||
| new_vp_uuid | String | 否 | 1663DD96-C9BE-B49E-6044-3AB3120F4B74 | ||
| new_vp_name | String | 否 | 88.107 | ||
| new_vp_type | Number | 否 | |||
| group_uuid | String | 否 | F6FCFC4D-EE04-946B-56F2-A52E91AFD5A8 | ||
| rule_uuid | String | 否 | 8264AEDC-815B-0FA1-1FEE-F8B4FD15E1F1 | ||
| bk_ip | String | 否 | 192.168.72.75 | ||
| bk_uuid | String | 否 | 8264AEDC-815B-0FA1-1FEE-F8B4FD15E1F1 | ||
| can_del | Number | 否 | 1 | 1 | |
| total | Number | 否 | 1 |
虚机恢复 - 状态
获取规则状态
SDK方法名：listVpRecoveryStatus
URL
/vp/recovery/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | 规则uuid数组 | ["11111111-1111-1111-1111-111111111111"] | |
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 | ||
| status | Array | 否 | |||
| rule_uuid | String | 否 | 8264AEDC-815B-0FA1-1FEE-F8B4FD15E1F1 | ||
| status | String | 否 | stop,executing,idle,dead,finish,switch,unknown, | FINISH | |
| progress | String | 否 | -6089.0 |
虚机恢复 - 操作
启动和停止恢复规则
SDK方法名：
启动：startVpRecovery;
停止：stopVpRecovery;
清除已完成：clearFinishVpRecovery;
URL
/vp/recovery/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 否 | 启动 : start; 停止 : stop; 清除已完成 : clear_finish | start | |
| rule_uuids | Array | 否 | 规则uuid数组, (仅在清除已完成操作时不传) | 641A27BB-B4D1-F482-1FB8-E856898626DA | |
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| rule_type | Number | 否 | clear_finish的恢复类型：0：普通；1：瞬时；(仅在清除已完成操作时传) | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| code | Number | 否 | @mock=0 | 0 | |
| message | String | 否 | 错误信息提示 | ||
| ret | Number | 否 | @mock=200, http code | 200 | |
| msg | String | 否 | 错误信息 |
虚机恢复 - 删除
删除恢复规则
SDK方法名：deleteVpRecovery
URL
/vp/recovery
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | 规则uuid数组 | ["11111111-1111-1111-1111-111111111111"] | |
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| delete_tgtvm | Number | 否 | 删除规则时，判断是否删除目标虚拟机。 1:删除 0:不删除。 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| code | Number | 否 | @mock=0 | 0 | |
| message | String | 否 | 错误信息提示 | ||
| ret | Number | 否 | @mock=200, http code | 200 | |
| msg | String | 否 | 错误信息 |
---- 虚机迁移/复制 ----
URL
/dash/vp_move_rep
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
虚机迁移/复制 - 新建
time_window字段说明：
格式：星期:时间1,时间2;星期:时间1,时间2,时间3
[0]星期：0-6，周日-周六
[1]时间：0（0:00-0:59）,1（1:00-1:59）,……，23（23:00-23:59）
SDK方法名：createVpMove/createVpRep
URL
/vp/(move|rep)
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_type | Number | 否 | 规则类型： 0: rep; 1: move; 10: rep temp; 11: move temp | 1 | |
| rule_name | String | 否 | 规则名称 | testMove1 cky | |
| src_uuid | String | 否 | 源平台uuid | 7F16E670-1A61-D565-6905-9C68B9520907 | |
| agent_uuid | String | 源平台为openstack时传，源平台代理节点uuid | |||
| source_region_id | String | 源平台区域ID | |||
| source_project_id | String | 源平台项目ID | |||
| vm_list | Array | 否 | |||
| vm_name | String | 否 | 新建虚拟机1 | ||
| vm_ref | String | 否 | vm-11877 | ||
| shd_name | String | 否 | 复制/迁移 新虚机名称 | 新建虚拟机1_move | |
| disk_list | Array | 否 | 虚机磁盘配置 | ||
| id | String | 否 | hyper-v有，磁盘uuid | ||
| disk_dir | String | 否 | |||
| disk_name | String | 否 | |||
| size | String | ||||
| datastore | String | 源机存储 | |||
| new_ds | String | 否 | 选择一个存储 | datastore2 | |
| is_ignored | Number | 否 | 选中为0，不选为1 | ||
| boot_index | Number | 仅限源平台为vmware时使用 | 1 | ||
| disk_provision_type | Number | 磁盘置备类型（仅限目标平台为vmware）： 0：源机磁盘配置； 1：为精简置备； 2：为厚置备延迟置零； 3：为厚置备置零； | 0 | ||
| disk_type | String | ||||
| dynamic_mem | Number | 否 | |||
| networks | Array | 否 | |||
| source_network_name | String | 否 | 源机network_name | ||
| source_network_id | String | 否 | 源机network_id | ||
| mac_address | String | 否 | 源机mac地址 | ||
| keep_mac | Number | 否 | 是否保留mac，默认为保留，传1 | 1 | |
| network_id | String | 否 | 没有勾选“自定义磁盘”时，将全局设置的网卡信息填进来 | ||
| network_name | String | 否 | 没有勾选“自定义磁盘”时，将全局设置的网卡信息填进来 | ||
| ip_address | String | ||||
| new_vm_name | String | 否 | 演练虚机名称 | ||
| scripts_type | String | 否 | 开启验证时： (*必填)脚本验证的方式，0表示验证ping方法验证，1表示tcp端口验证测试，2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0 | ||
| scripts | String | 否 | 开启验证时： 验证内容 | ||
| cpu | String | 否 | 开启验证时： cpu数 | ||
| core_per_sock | String | 否 | 开启验证时： 单个cpu核数 | ||
| mem_mb | String | 否 | 开启验证时： 内存大小 | ||
| os_type | Number | 否 | 开启验证时： 操作系统： 0：linux； 1：windows | ||
| flavor_id | String | 虚机迁移，目标平台是云平台时，目标机规格id | |||
| vm_uuid | String | 虚机uuid标识 | |||
| sync_down | Boolean | 向下同步标记 | false | ||
| is_set | Number | 是否设置了自定义设置： 0：否； 1：是； | 0 | ||
| orch_disks | Array | 演练虚机磁盘配置，具体参数请参照vm_list.disk_list字段（暂时废弃） | |||
| id | String | ||||
| disk_dir | String | ||||
| disk_name | String | ||||
| size | String | ||||
| datastore | String | ||||
| new_ds | String | ||||
| ignored | String | ||||
| boot_index | String | ||||
| disk_provision_type | String | ||||
| disk_type | String | ||||
| orch_networks | Array | ||||
| source_network_name | String | 源机network_name | |||
| source_network_id | String | 源机network_id | |||
| mac_address | String | 源机mac地址 | |||
| keep_mac | String | 是否保留mac，默认为保留，传1 | |||
| network_id | String | 目标平台演练虚机网卡名称（不允许修改） | |||
| network_name | String | 目标平台演练虚机网卡id（不允许修改） | |||
| ip_address | String | ||||
| orch_cpu_num | String | 演练虚机cpu数 | |||
| orch_cores_per_cpu_num | String | 演练虚机核心数 | |||
| orch_memory_mb | String | 演练虚机内存 | |||
| biz_grp_list | Array | 否 | 业务分组：组uuid数组 | ||
| bk_uuid | String | 否 | 备机 uuid（目标平台openstack,目标平台代理节点uuid） | 67E33CDB-D75B-15B3-367D-50C764F5A26F | |
| target_region_id | String | 目标平台区域ID | |||
| target_project_id | String | 目标平台项目ID | |||
| bk_path | String | 否 | 备份路径（临时目录） | H:\vp_rep\ | |
| tgt_uuid | String | 否 | 目标平台uuid | 7F16E670-1A61-D565-6905-9C68B9520907 | |
| new_dc | String | 否 | 数据中心 (openstack不传) | i2test | |
| new_dc_mor | String | 否 | 数据中心标识 (openstack不传) | datacenter-2 | |
| new_host | String | 否 | 主机名称 (openstack不传) | 192.168.88.103 | |
| new_ds | String | 否 | 存储 (openstack不传) | 103-数据盘 | |
| bkup_policy | Number | 否 | 自动同步开关：0：不开启自动同步；1：开启自动同步； | 0 | |
| backup_type | String | 否 | 默认传 i | i | |
| bkup_schedule | Object | 否 | 同步策略 | ||
| sched_time_start | String | 否 | 复制： 自动同步不开启：传 0； 每小时，对应页面上开始时间，格式：2018-09-14 15:38:00; 每天，传 “”空串； 每周/月，传 当前日期（前端生成，如 2018-09-03） + 运行时间（页面输入 08:00:00），格式：2018-09-03 08:00:00； 迁移：空； | 0 | |
| limit | Number | 否 | 备份数据保留个数：整数；不开自动同步是0； | 0 | |
| sched_day | Array | 否 | 某几天，“每周/每月”循环专用参数，取值（整型）：每周：0-6 对应 周日-周六；每月：1-31 对应 第1-31号； | "@integer(1, 31)" | |
| sched_every | Number | 否 | 0：每天；1：每周：2：每月；3：每隔（每小时）； | 0 | |
| sched_time | Array | 否 | 某几点：“每天”循环专用参数，取值：为 HH:mm 的数组； | ||
| sched_gap_min | Number | 否 | 复制：有用到间隔时间填间隔时间>=10，不需要这个值则默认0，迁移： 0 | 0 | |
| quick_back | Number | 否 | 快速传输 选中为1，不选中为0 | 1 | |
| quiet_snap | Number | 否 | 静默快照：0：开；1：关； | 1 | | @mock=0 |
| lan_free | Number | 否 | 选中：31 不选中：23 | 23 | |
| src_trans_mode | Number | 源平台数据传输模式： 1：nbd； 2：nbdssl； 4：hotadd； 8：san； 31：auto； | 31 | ||
| dest_trans_mode | Number | 目标平台数据传输模式： 1：nbd； 2：nbdssl； 4：hotadd； 8：san； 31：auto； | 31 | ||
| mem_snap | Number | 否 | 是否开启内存快照，0关1开(迁移时才有) | ||
| band_width | String | 否 | -1 | ||
| automate | Number | 否 | 复制，默认：1；迁移：勾选自动迁移 1，不勾选0； | 0 | |
| auto_shutdown | Number | 否 | 迁移完成关闭源机，0否1是，默认0； | 0 | |
| auto_startup | Number | 否 | 迁移完成开启备机，0否1是，默认0； | 0 | |
| auto_shutdown_before_incremental | Number | 增量迁移前关闭源虚机 | 0 | ||
| overwrite | Number | 否 | 是否覆盖虚机：1：是；0：否；(由原先的单独配置，变为全局配置) | ||
| network_id | String | 否 | |||
| network_name | String | 否 | |||
| ip_address | String | ||||
| add_drill | Number | 否 | 是否开启认证： 0：否， 1：是， 默认否 | ||
| auto | String | 否 | 开启验证时必传： 自动验证： 自动：1，手动：0； | ||
| drill_plat_uuid | String | 否 | 开启验证时传： 目标平台的vp_uuid | ||
| data_ip_uuid | String | 数据地址 | 7F16E670-1A61-D565-6905-9C68B9520901 | ||
| transfer_compression | Number | 传输压缩： 0：关； 1：开； | 0 | ||
| transfer_encrypt | Number | 传输加密： 0：关； 1：开； | 0 | ||
| consolidate_switch | Number | 磁盘整合开关： 0：关； 1：开 | 0 | ||
| consolidate_disks_time | String | 磁盘整合时间 | |||
| concurrent_disk_threads | Number | 磁盘传输并发数 默认值 2 值为 1 2 3 4 | |||
| auto_start | Number | 是否自启动： 0：否； 1：是； | 1 | ||
| bkup_one_time | String | 预约启动时间，时间戳 | |||
| location | String | FC，计算资源id | |||
| location_name | String | FC，计算资源名称 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | @mock=200, http code | 200 | |
| msg | String | 否 | 错误信息 | ||
| data | Object | 否 | |||
| code | Number | 否 | @mock=0 | 0 | |
| message | String | 否 | 错误信息提示 | ||
| success_list | Array | ||||
| fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| vm_name | String | ||||
| rule_uuid | String | ||||
| conflict_rule_name | String | ||||
| conflict_vm_name | String | ||||
| conflict_username | String |
虚机复制 - 批量创建
SDK方法名：batchCreateVpRep
URL
/vp/rep/batch
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| base_info_list | Object | ||||
| tgt_uuid | String | 目标平台uuid | |||
| new_dc | String | ||||
| new_dc_mor | String | ||||
| new_host | String | ||||
| new_ds | String | ||||
| rule_type | Number | 规则类型 | 0 | ||
| biz_grp_list | String | ||||
| quick_back | Number | 1 | |||
| quiet_snap | Number | 1 | |||
| lan_free | Number | 23 | |||
| mem_snap | Number | 1 | |||
| band_width | String | -1 | |||
| auto_shutdown | Number | 1 | |||
| auto_startup | Number | 0 | |||
| overwrite | Number | 1 | |||
| bkup_schedule | Object | ||||
| sched_time_start | String | ||||
| limit | Number | ||||
| sched_day | String | ||||
| sched_every | Number | ||||
| sched_time | Array | ||||
| sched_gap_min | Number | 0 | |||
| bkup_policy | Number | ||||
| backup_type | String | i | |||
| automate | Number | 0 | |||
| network_id | String | 全局网卡id | |||
| network_name | String | 全集网卡name | |||
| vm_list | Array | ||||
| vm_uuid | String | 虚机uuid | |||
| vm_name | String | 新建虚拟机1 | |||
| vm_ref | String | vm-11877 | |||
| shd_name | String | 新建虚拟机1_move | |||
| disk_list | Array | ||||
| disk_path | String | ||||
| disk_name | String | [datastore1 (1)] 测试11_临时测试11/测试11_临时测试11_5-000002.vmdk | |||
| new_ds | String | datastore2 | |||
| id | String | ||||
| is_ignored | Number | 1 | |||
| dynamic_mem | Number | 1 | |||
| networks | Array | ||||
| network_id | String | ||||
| network_name | String | ||||
| keep_mac | Number | 1 | |||
| source_network_name | String | ||||
| source_network_id | String | ||||
| mac_address | String | ||||
| bk_uuid | String | ||||
| bk_path | String | ||||
| new_vm_name | String | 验证参数 | |||
| scripts_type | String | 验证参数 | |||
| scripts | String | 验证参数 | |||
| cpu | String | ||||
| core_per_sock | String | ||||
| mem_mb | String | ||||
| os_type | Number | 验证参数 | 1 | ||
| add_drill | Number | 验证总开关 | |||
| auto | Number | 是否自动验证 | |||
| common_params | Object | ||||
| batch_name | String | 批量新建任务名称 | |||
| rep_prefix | String | 名称前缀 | |||
| rep_sufix | String | 名称后缀 | |||
| variable_type | Number | 批量任务： 变量名，0，节点名称；1，节点ip,虚机复制固定传2，表示虚机名称 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String |
虚机复制 - 修改
URL参数为 group_uuid；
接口入参和新建一样，修改规则为新建完整规则参数；
SDK方法名：modifyVpRepGroup;
URL
/vp/rep/group/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| new_ds | String | 否 | 103-数据盘 | ||
| support_cbt | Number | 否 | 1 | ||
| tgt_uuid | String | 否 | 7F16E670-1A61-D565-6905-9C68B9520907 | ||
| del_bkup_swap | Number | 否 | 0 | ||
| src_uuid | String | 否 | 7F16E670-1A61-D565-6905-9C68B9520907 | ||
| bk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | ||
| automate | Number | 否 | 0 | ||
| rule_name | String | 否 | testMove1 cky | ||
| new_dc | String | 否 | i2test | ||
| bk_path | String | 否 | H:\vp_rep\ | ||
| backup_type | String | 否 | i | ||
| new_host | String | 否 | 192.168.88.103 | ||
| quiet_snap | Number | 否 | 1 | ||
| bkup_schedule | Object | 否 | |||
| sched_time_start | String | 否 | 0 | ||
| limit | Number | 否 | 0 | ||
| sched_day | Number | 否 | 21 | ||
| sched_every | Number | 否 | 0 | ||
| sched_time | Array | 否 | |||
| sched_gap_min | Number | 否 | 0 | ||
| quick_back | Number | 否 | 1 | ||
| del_bkup_data | Number | 否 | 0 | ||
| lan_free | Number | 否 | 23 | ||
| vm_list | Array | 否 | |||
| vm_name | String | 否 | 新建虚拟机1 | ||
| vm_ref | String | 否 | vm-11877 | ||
| shd_name | String | 否 | 新建虚拟机1_move | ||
| overwrite | Number | 否 | 0 | ||
| disk_list | Array | 否 | |||
| disk_path | String | 否 | |||
| disk_name | String | 否 | [datastore1 (1)] 测试11_临时测试11/测试11_临时测试11_5-000002.vmdk | ||
| new_ds | String | 否 | datastore2 | ||
| id | String | 否 | |||
| time_window | String | 否 | |||
| new_dc_mor | String | 否 | datacenter-2 | ||
| bkup_policy | Number | 否 | 0 | ||
| band_width | String | 否 | -1 | ||
| rule_type | Number | 否 | 1 | ||
| auto_shutdown | Number | 否 | 1 | ||
| data_ip_uuid | String | 灾备机数据地址 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功 |
虚机迁移/复制 - 获取单个
查看规则
SDK方法名：describeVpMove/describeVpRep
URL
/vp/(move|rep)/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| vp_rep | Object | 否 | |||
| new_ds | String | 否 | |||
| support_cbt | Number | 否 | 1 | ||
| tgt_uuid | String | 否 | @guid() | ||
| del_bkup_swap | Number | 否 | 1 | ||
| src_uuid | String | 否 | 83EAde4d-52C8-9D4d-2BDF-52165B83fDAe | ||
| bk_uuid | String | 否 | @guid() | ||
| automate | Number | 否 | 1 | ||
| rule_name | String | 否 | @name | ||
| new_dc | String | 否 | |||
| bk_path | String | 否 | |||
| backup_type | String | 否 | |||
| new_host | String | 否 | |||
| quiet_snap | Number | 否 | 1 | ||
| bkup_schedule | Object | 否 | |||
| sched_time_start | String | 否 | |||
| limit | Number | 否 | 1 | ||
| sched_day | Number | 否 | 24 | ||
| sched_every | Number | 否 | 1 | ||
| sched_time | Array | 否 | |||
| sched_gap_min | Number | 否 | 1 | ||
| quick_back | Number | 否 | 1 | ||
| del_bkup_data | Number | 否 | 1 | ||
| lan_free | Number | 否 | 1 | ||
| vm_list | Array | 否 | 2 | ||
| vm_name | String | 否 | @name | ||
| vm_ref | String | 否 | 1 | ||
| shd_name | String | 否 | @name | ||
| overwrite | Number | 否 | 1 | ||
| cpu | String | 否 | 存在对应演练规则时返回: cpu数 | ||
| core_per_sock | String | 否 | 存在对应演练规则时返回: 单个cpu核数 | ||
| mem_mb | String | 否 | 存在对应演练规则时返回: 内存大小 | ||
| os_type | Number | 否 | 存在对应演练规则时返回: 操作系统： 0：linux； 1：windows | ||
| time_window | String | 否 | |||
| new_dcmor | String | 否 | |||
| src_name | String | 否 | |||
| tgt_name | String | 否 | |||
| username | String | 否 | |||
| user_uuid | String | 否 | @guid() | ||
| rule_uuid | String | 否 | @guid() | ||
| group_uuid | String | 否 | @guid() | ||
| create_time | String | 否 | |||
| bkup_policy | Number | 否 | 1 | ||
| data_ip_uuid | String | 81EAde4d-52C8-9D4d-2BDF-52165B83fDAe |
虚机迁移/复制 - 修改模板
time_window字段说明：
格式：星期:时间1,时间2;星期:时间1,时间2,时间3
[0]星期：0-6，周日-周六
[1]时间：0（0:00-0:59）,1（1:00-1:59）,……，23（23:00-23:59）
SDK方法名：modifyVpMove/modifyVpRep
URL
/vp/(move|rep)/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | 否 | 规则名称 | ||
| src_uuid | String | 否 | 源平台uuid | @guid() | |
| tgt_uuid | String | 否 | 目标平台uuid | ||
| bk_uuid | String | 否 | 备机 uuid | ||
| bk_path | String | 否 | 备份路径（临时目录） | ||
| new_dc | String | 否 | 数据中心 | ||
| new_dc_mor | String | 否 | 数据中心标识 | ||
| new_host | String | 否 | 主机名称 | ||
| new_ds | String | 否 | 存储 | ||
| quiet_snap | Number | 否 | 静默快照：0：开；1：关； | 1 | | @mock=0 |
| support_cbt | Number | 否 | 支持cbt:1 不支持 cbt :0 | ||
| del_bkup_swap | Number | 否 | 复制：勾选删除临时目录 传1 ，不勾选传0，迁移默认为0 | ||
| automate | Number | 否 | 复制，默认：1；迁移：勾选自动迁移 1，不勾选0； | ||
| backup_type | String | 否 | 默认传 i | ||
| vm_list | Array | 否 | 2 | ||
| bkup_policy | Number | 否 | 自动同步开关：0：不开启自动同步；1：开启自动同步； | ||
| bkup_schedule | Object | 否 | 同步策略 | ||
| quick_back | Number | 否 | 快速传输 选中为1，不选中为0 | ||
| del_bkup_data | Number | 否 | 删除虚拟机 勾选 1 不勾选 0 | ||
| lan_free | Number | 否 | 选中：31 不选中：23 | ||
| time_window | String | 否 | 勾选时间窗口时候需要下发，格式见说明 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | @mock=200, http code | 200 | |
| msg | String | 否 | 错误信息 | ||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 |
虚机迁移/复制 - 获取列表
SDK方法名：listVpMove/listVpRep
URL
/vp/(move|rep)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| type | String | 规则类型： 0: rep; 1: move; 10: rep temp; 11: move temp | |||
| page | Number | 否 | 1 | ||
| limit | Number | 否 | 10 | ||
| status | String | 可选，总览页面跳转时按照状态过滤时需要 REPLICATION MAINTAIN WAIT FINISH STOP UNKNOWN |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| info_list | Array | 否 | 2 | ||
| rule_name | String | 否 | 规则名称 | @word | |
| src_name | String | 否 | 源平台名称 | @word | |
| group_uuid | String | 否 | @guid | ||
| tgt_name | String | 否 | 目标虚拟平台 | @word | |
| bk_node_name | String | 否 | 备机名称 | @name | |
| username | String | 否 | 所有者 | @name | |
| rule_uuid | String | 否 | 单个规则uuid | @guid | |
| vm_name | String | 否 | 虚机名称 | @word | |
| can_del | Number | 否 | 1 | 1 | |
| can_drill | Number | 目标平台是否开启演练,0否；1是 | |||
| src_type | Number | 源平台类型 | |||
| tgt_type | Number | 目标平台类型 | |||
| automate | Number | 是否自动迁移，1；迁移：勾选自动迁移 1，不勾选0； | |||
| new_dc | String | 目标平台数据中心 | |||
| new_host | String | 目标平台主机 | |||
| ret | Number | 否 | 200 | ||
| msg | String | 否 |
虚机迁移/复制 - 状态
SDK方法名：listVpMoveStatus/listVpRepStatus
URL
/vp/(move|rep)/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | 规则uuid | ["11111111-1111-1111-1111-111111111111"] | |
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | |||
| data | Object | 否 | |||
| status | Array | 否 | 2 | ||
| rule_uuid | String | 否 | 规则uuid | @guid() | |
| progress | Number | 否 | 进度 | @int(1,100) | |
| status | String | 否 | stop,executing,idle,dead,finish,switch,unknown | @pick(["STOP","EXECUTING","IDLE","DEAD","FINISH","SWITCH","UNKNOWN","VP_START","VP_CHECK","VP_CFG","VP_CBT","VP_PREPARE_MV","VP_PREPARE_PT","CREATING"]) | |
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| ret | Number | 否 | 200 |
虚机迁移/复制 - 操作
SDK方法名：
停止：stopVpMove/stopVpRep
开始：startVpMove/startVpRep
开始迁移： moveVpMove
切换： failoverVpRep
回切： failbackVpRep
创建目标主机：createTargeVm
URL
/vp/(move|rep)/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 否 | 开：start；停：stop；迁移：move; 切换：failover；回切：failback； 虚机复制: 立即启动 - start_immediately 虚机迁移： （目标平台为openstack，规则没有开启自动迁移时）创建目标主机：create_target_vm； （迁移就绪状态时）迁移完成：finish | start | |
| rule_uuids | Array | 否 | 1C89A121-6B03-24B2-9273-D4B93C0687AD | ||
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| snap_point | String | 否 | 切换专用参数：选择需要切换到的时间点 | ||
| op_code | String | 否 | 切换专用参数：0表示临时切换；1表示永久切换 | ||
| power_on | Number | 切换专用参数：1为自动开机。默认不传为0 | |||
| power_off | Number | （非必填）1：关闭目标机 0：不关闭 （备份中心分支使用） | |||
| bkup_type | String | 立即执行操作（start_immediately）必传，取值为，备份策略 - 周期任务 - 备份方式；0：全备，1：增量，2：差异，3：合成 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| message | String | 否 | |||
| code | Number | 否 | 0 | ||
| ret | Number | 否 | 200 | ||
| msg | String | 否 |
虚机迁移/复制 - 删除
删除规则
SDK方法名：deleteVpMove/deleteVpRep
URL
/vp/(move|rep)
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | 规则uuid | ["11111111-1111-1111-1111-111111111111"] | |
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| delete_tgtvm | Number | 否 | 删除规则时，判断是否删除目标虚拟机。 1:删除 0:不删除。 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | |||
| ret | Number | 否 | 200 | ||
| data | Object | 否 | |||
| message | String | 否 | |||
| code | Number | 否 | @mock=0 | 0 |
虚机迁移/复制 - 获取快照
URL中uuid为rule_uuid：
切换操作前，获取快照列表信息；流程：新建个带策略的复制，【已完成】时，点击切换，获取时间点列表，有内容的话，选择一个时间点，选择永久切换还是临时切换，确定；
SDK方法名：
复制：listVpRepPointList;
迁移：listMovePointList;
URL
/vp/rep/:uuid([A-F0-9-]+)/point_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| type | String | 规则类型。 默认不用传为虚机复制； 如果需要获取整机备份的备份点列表，传'fsp' | |||
| all | Number | 仅备份中心分支使用 0:只获取演练成功的备份点 1:所有 | 1 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 | ||
| list | Array | 否 | 快照时间点列表，已经时间点对应的目标机配置信息 | ||
| snap_name | String | 快照时间点 | 2018-10-24 16:55:09 | ||
| memory_in_mb | String | 内存 | |||
| cpu_num | String | cpu | |||
| cores_per_cpu | String | 核心数 | |||
| networks | Array | ||||
| network_id | String | 网络ID | |||
| network_name | String | 网络名称 | |||
| mac_address | String | 网卡MAC地址 | |||
| disks | Array | ||||
| id | String | 磁盘ID | |||
| disk_name | String | 磁盘名称 | |||
| size | String | 磁盘大小 | |||
| disk_dir | String | 磁盘所在目录 | |||
| datastore | String | 磁盘所在的存储，只在vmware平台上有，其他平台为空。 | |||
| boot_index | String | (选填) 磁盘启动顺序，openstack云平台下0：启动盘；1或者其他数字表示非启动盘。vmware，cas，hyperv平台，因为npsvr无法判断磁盘是否为启动盘，所以由页面按磁盘顺序依次递增。 | |||
| os_type | String | 虚拟机操作系统类型 | |||
| bk_path | String | 复制规则的目录 | |||
| os_type | String | 操作系统类型 | 1 |
------ 虚机演练 ------
URL
/vp/vp_drill
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
演练规则 - 列表
获取规则列表；获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；
SDK方法名：listVpDrill
URL
/vp/drill
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 否 | 可选 | 1 | |
| limit | Number | 否 | 可选 | 10 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| info_list | Array | 否 | |||
| group_uuid | String | 否 | f3fE9a51-2466-3EaE-aCe6-e3d18CA33ece | ||
| rule_name | String | 否 | Donna Smith | ||
| rule_uuid | String | 否 | E3EdA75B-Db84-c4EF-75d7-DfbaacdCB5eF | ||
| vp_uuid | String | 否 | DcDd4A7d-2Ae3-bFd7-d346-14F0A9Fad77C | ||
| vp_name | String | 否 | Mary Jackson | ||
| vp_type | Number | 否 | 0 | ||
| vp_addr | String | 否 | |||
| bk_uuid | String | 否 | 4b72eF52-e9a6-bfAd-e22B-5F79ffbe4B72 | ||
| bk_node_name | String | 否 | Anna Anderson | ||
| bk_path | String | 否 | /temp/ | ||
| vm_name | String | 否 | Paul Perez | ||
| username | String | 否 | Daniel Smith | ||
| auto | String | 否 | |||
| vm_ref | String | 否 | |||
| can_del | Number | 1 | |||
| total | Number | 否 | 1 |
演练规则 - 新建
SDK方法名：createVpDrill
URL
/vp/drill
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_type | Number | 是 | 对应规则类型：备份：0；复制：1；整机备份：2 ；整机复制：3 | 0 | |
| rule_name | String | 是 | 规则名称（备份规则任务和复制规则任务的名称） | ||
| vp_uuid | String | 是 | 演练平台对应 虚拟平台的ID | ||
| auto | Number | 否 | 自动演练：自动：1，手动：0； | 0 | |
| vm_list | Array | 否 | |||
| vm_name | String | 否 | 虚机(工作机)名称 | ||
| wk_uuid | String | 工作机uuid (整机备份类型，必传) | |||
| vm_ref | String | 否 | 虚机ID (整机备份类型，不传) | 99 | |
| new_vm_name | String | 否 | 新虚机名称 | ||
| cpu | Number | 否 | 处理器数量 | 1 | |
| core_per_sock | Number | 否 | 处理器核心数量 | 1 | |
| mem_mb | Number | 否 | 内存大小 | 1024 | |
| scripts | String | 否 | 演练脚本 | ||
| scripts_type | Number | 否 | (*必填)脚本验证的方式，0表示验证ping方法验证，1表示tcp端口验证测试，2表示脚本验证方式。2表示脚本验证方式目前暂存以后实现。默认值为0 | ||
| bk_uuid | String | 否 | 源规则 bk_uuid | ||
| bk_type | Number | 备份存储类型： 0：文件系统； 1：对象存储； | 0 | ||
| bk_path | String | 否 | 源规则 bk_path | ||
| sto_uuid | String | 对象存储uuid | |||
| bucket_ | String | 对象桶（name） | |||
| bucket_path | String | 桶路径 | |||
| original_rule_uuid | String | 否 | 原始规则uuid | ||
| os_type | Number | 否 | （新加）虚拟机操作系统： 0：linux； 1：windows | ||
| ver_sig | String | 否 | 信息ID | ||
| time | String | 否 | 选择的时间点，RPC不用 | ||
| src_uuid | String | 源规则的源平台uuid，获取导入的虚机信息时需要用到 | |||
| data_ip_uuid | String | 灾备机数据地址 | |||
| disk_list | Array | ||||
| id | String | hyper-v，磁盘uuid | |||
| disk_dir | String | ||||
| disk_name | String | 磁盘名称 | |||
| datastore | String | 源机存储 | |||
| new_ds | String | 选择的存储 | |||
| is_ignored | Number | 是否忽略: 0：否； 1：是 | |||
| size | String | 磁盘大小 | |||
| boot_index | Number | 引导顺序 | |||
| networks | Array | ||||
| source_network_name | String | 源机网卡名称 | |||
| source_network_id | String | 源机网卡id | |||
| mac_address | String | mac地址 | |||
| keep_mac | String | 保留mac | |||
| network_id | String | 目标平台演练虚机网卡ID，不可以修改 | |||
| network_name | String | 目标平台演练虚机网卡名称，不可以修改 | |||
| ip_address | String | ||||
| quick_back | Number | 否 | 1 | ||
| backup_type | String | 否 | i | ||
| lan_free | Number | 否 | 23 | ||
| del_bkup_data | Number | 否 | 0 | ||
| automate | Number | 否 | 隐藏开关，默认传0，页面不显示 | 0 | |
| auto_shutdown | Number | 否 | 1 | ||
| bkup_policy | Number | 否 | 0 | ||
| bkup_schedule | Object | 否 | |||
| sched_time_start | String | 否 | 0 | ||
| limit | Number | 否 | 0 | ||
| sched_day | Number | 否 | 6 | ||
| sched_every | Number | 否 | 0 | ||
| sched_time | Array | 否 | |||
| sched_gap_min | Number | 否 | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功 | ||
| rule_uuid | String | 否 | |||
| vm_name | String | 否 | |||
| new_vm_name | String | 否 |
演练规则 - 获取单个（组）
查看规则，URL参数为 group_uuid
SDK方法名：describeVpDrill
URL
/vp/drill/group/: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] 操作成功 | ||
| vp_drill_rule | Object | 否 | |||
| rule_name | String | 否 | |||
| rule_type | Number | 否 | 0 | ||
| vp_uuid | String | 否 | |||
| bk_uuid | String | 否 | |||
| bk_path | String | 否 | |||
| datacenter | String | 否 | |||
| hostname | String | 否 | |||
| datastore | String | 否 | |||
| auto | Number | 否 | 0 | ||
| scripts | String | 否 | |||
| vm_list | Array | 否 | |||
| vm_name | String | 否 | |||
| new_vm_name | String | 否 | |||
| vm_ref | String | 否 | 99 | ||
| mac | String | 否 | |||
| cpu | Number | 否 | 1 | ||
| ver_sig | String | 否 | |||
| core_per_sock | Number | 否 | 1 | ||
| mem_mb | Number | 否 | 1024 | ||
| overwrite | Number | 否 | 0 | ||
| quick_back | Number | 否 | 1 | ||
| backup_type | String | 否 | i | ||
| lan_free | Number | 否 | 23 | ||
| del_bkup_data | Number | 否 | 0 | ||
| del_bkup_swap | Number | 否 | 0 | ||
| automate | Number | 否 | 0 | ||
| auto_shutdown | Number | 否 | 1 | ||
| bkup_policy | Number | 否 | 0 | ||
| bkup_schedule | Object | 否 | |||
| sched_time_start | String | 否 | 0 | ||
| limit | Number | 否 | 0 | ||
| sched_day | Number | 否 | 6 | ||
| sched_every | Number | 否 | 0 | ||
| sched_time | Array | 否 | |||
| sched_gap_min | Number | 否 | 0 | ||
| rule_uuid | String | 否 | |||
| group_uuid | String | 否 | |||
| vp_name | String | 否 | 88.107 | ||
| vp_type | Number | 否 | 0 | ||
| bk_node_name | String | 否 | 88.107 | ||
| user_uuid | String | 否 | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | ||
| username | String | 否 | admin | ||
| create_time | String | 否 | 1533871285 | ||
| random_str | String | 否 | AB790B28-62D6-7236-612F-65D73C80036F | ||
| biz_grp_list | Array | 否 | |||
| data_ip_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC |
演练规则 - 删除
删除规则
SDK方法名：deleteVpDrill
URL
/vp/drill
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | ||
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| delete_tgtvm | Number | 是否删除演练虚机，0，1 | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功 |
演练规则 - 状态
获取规则的状态
SDK方法名：listVpDrillStatus
URL
/vp/drill/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 否 | ["11111111-1111-1111-1111-111111111111"] | ||
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | |||
| data | Object | 否 | |||
| count | String | 否 | 1 | ||
| message | String | 否 | |||
| code | Number | 否 | 0 | ||
| status | Array | 否 | 2 | ||
| status | String | 否 | SUCCESS FAILED | VP_START | |
| progress | Number | 否 | 71 | ||
| rule_uuid | String | 否 | Ac2F4EFC-14FE-b2Ab-7988-7AD4f44979E3 | ||
| ret | Number | 否 | 200 |
演练规则 - 获取控制台地址
SDK方法名：getConsoleUrl;
URL
/vp/drill/console_url
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuid | String | 规则uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| console_url | String | 演练机控制台地址 |
演练规则 - 操作
SDK方法名：
停止：stopVpDrill
开始：startVpDrill
设置状态： setStatusVpDrill
URL
/vp/drill/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 否 | "start", "stop", "set_status"：启动、停止、设置状态（仅运行状态可以） | ||
| rule_uuids | Array | 否 | 规则uuid列表 | [C6335F62-2565-1957-4BB9-587F2FF46B00] | |
| group_uuids | Array | 否 | 组操作，有这个就先用这个，没有就用规则uuid | ||
| status | String | 否 | 仅设置状态传：状态码，0成功，-1失败 | ||
| msg | String | 否 | 仅设置状态传：用户上传的信息 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功 |
----- 虚机文件恢复 -----
URL
/dash/vp_file_recovery
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
文件恢复 - 新建
SDK方法名：createVpFileRecovery
URL
/vp/file_recovery
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | 规则名称 | |||
| config_addr | String | 管理地址 | |||
| config_port | String | 管理端口 | |||
| attach_dir | String | 挂载点 | |||
| bk_uuid | String | 灾备机uuid | |||
| bk_type | Number | 备份存储类型： 0：文件系统； 1：对象存储； | 0 | ||
| bk_path | String | 灾备路径 | |||
| sto_uuid | String | 对象存储uuid | |||
| bucket | String | 对象桶（name） | |||
| bucket_path | String | 桶路径 | |||
| vm_name | String | 虚机名称 | |||
| version_id | String | 备份点id | |||
| version_time | String | 备份点时间 | |||
| tgt_uuid | String | 目标机uuid(新建传'') | |||
| tgt_path | String | 目标路径(新建传'') | |||
| files | Array | 文件列表(新建传'') |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功 |
文件恢复 - 修改
SDK方法名：modifyVpFileRecovery
URL
/vp/file_recovery/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuid | String | ||||
| rule_name | String | ||||
| config_addr | String | ||||
| config_port | String | ||||
| attach_dir | String | ||||
| attach_path | String | 实际挂载路径 | |||
| bk_uuid | String | ||||
| bk_path | String | ||||
| vm_name | String | ||||
| version_id | String | ||||
| version_time | String | ||||
| tgt_uuid | String | ||||
| tgt_path | String | ||||
| files | Array | ||||
| random_str | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功 |
文件恢复 - 列表
SDK方法名：listVpFileRecovery
URL
/vp/file_recovery
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 1 | |||
| limit | Number | 10 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| info_list | Array | ||||
| rule_uuid | String | 规则uuid | 111 | ||
| vm_name | String | 虚机名称 | |||
| bk_uuid | String | 灾备机uuid | |||
| bk_node_name | String | 灾备机名称 | |||
| attach_path | String | 底层返回的实际挂载路径 | |||
| tgt_uuid | String | 目标机uuid | |||
| tgt_node_name | String | 目标机名称 | |||
| total | Number | 1 |
文件恢复 - 获取单个
SDK方法名：describeVpFileRecovery
URL
/vp/file_recovery/: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] 操作成功 | |||
| vp_file_recovery | Object | ||||
| rule_uuid | String | 规则uuid | |||
| rule_name | String | 规则名称 | |||
| attach_dir | String | 挂载点 | |||
| attach_path | String | 实际挂载路径 | |||
| bk_uuid | String | 灾备机uuid | |||
| bk_path | String | 数据存放路径 | |||
| vm_name | String | 虚机名称 | |||
| version_id | String | 备份点id | |||
| version_time | String | ||||
| tgt_uuid | String | 目标机uuid | |||
| tgt_path | String | 目标路径 | |||
| files | Array | 文件列表 | |||
| String | |||||
| user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| create_time | String | 1533871285 | |||
| random_str | String | AB790B28-62D6-7236-612F-65D73C80036F |
文件恢复 - 操作
SDK方法名：
挂载：attachVpFileRecovery
卸载：detachVpFileRecovery
URL
/vp/file_recovery/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 挂载：attach 卸载：detach 启动：start 停止：stop | |||
| rule_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | ||||
| message | String | ||||
| code | Number | -1 | |||
| success_list | Array | 成功的列表 | |||
| code | String | ||||
| message | String | ||||
| rule_uuid | String | ||||
| rule_name | String | ||||
| fail_list | Array | 失败的列表 | |||
| code | String | ||||
| message | String | ||||
| rule_uuid | String | ||||
| rule_name | String | ||||
| ret | Number | 200 | |||
| msg | String |
文件恢复 - 状态
SDK方法名：listVpFileRecoveryStatus
URL
/vp/file_recovery/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | ||||
| force_refresh | Number | 点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| count | String | 1 | |||
| message | String | ||||
| code | Number | 0 | |||
| status | Array | ||||
| rule_uuid | String | 111 | |||
| status | String | 挂载中：VP_ATTACHING； 卸载中：VP_DETACHING； 未挂载：VP_NOT_ATTACHED； （空闲就是已挂载） | STOP | ||
| ret | Number | 200 |
文件恢复 - 删除
SDK方法名：deleteVpFileRecovery
URL
/vp/file_recovery
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| String | |||||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| success_list | Array | ||||
| rule_name | String | ||||
| rule_uuid | String | ||||
| code | String | ||||
| message | String | ||||
| fail_list | Array | ||||
| rule_name | String | ||||
| rule_uuid | String | ||||
| message | String | ||||
| code | String | ||||
| ret | Number | 200 | |||
| msg | String |