备份中心
备份中心
SDK类名:/resource/AppSystem;
------- 二级目录 -------
URL
/------- 二级目录 -------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
获取列表
SDK类名:/resource/AppSystem;
SDK方法名:secDirList;
URL
/sec_dir
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
total | Number | 否 | 1 | ||
info_list | Array | 否 | |||
id | Number | 否 | 主键id | 1 | |
dir_uuid | String | 否 | 二级目录uuid | B8566905-411E-B2CD-A742-77B1346D8E35 | |
dir_name | String | 否 | 二级目录名称 | 备份中心 | |
children | Array | 否 | 子目录 | ||
id | Number | 否 | 主键id | 2 | |
dir_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
dir_name | String | 否 | 二级目录 | ||
children | Array | 否 | 子目录,以此类推 | ||
can_up | Number | ||||
can_op | Number | ||||
can_del | Number | ||||
message | String | 否 |
新建
SDK类名:/resource/AppSystem;
SDK方法名:createSecDir;
URL
/sec_dir
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
pid | Number | 否 | 父级目录id | ||
dir_name | String | 否 | 二级目录名称 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | [0] 操作成功 | ||
dir_uuid | String | 否 | 二级目录uuid,成功返回 | 67E33CDB-D75B-15B3-367D-50C764F5A26E | |
pid | String | 否 | 父级目录id,成功返回 | 2 |
修改
SDK类名:/resource/AppSystem;
SDK方法名:modifySecDir;
URL
/sec_dir/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
dir_name | String | 否 | 二级目录名称 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | [0] 操作成功 |
删除
SDK类名:/resource/AppSystem;
SDK方法名:deleteSecDir;
URL
/sec_dir
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
dir_uuids | Array | 否 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | |||
fail_list | Array | 否 | |||
code | Number | 否 | 1 | ||
message | String | 否 | |||
dir_uuid | String | 否 | |||
dir_name | String | 否 | |||
success_list | Array | 否 | |||
code | Number | 否 | 1 | ||
message | String | 否 | |||
dir_uuid | String | 否 | |||
dir_name | String | 否 | |||
ret | Number | 否 | 200 |
------- 应用系统管理 -------
URL
/dash1
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
获取列表
SDK类名:/resource/AppSystem;
SDK方法名:appSystemList;
URL
/app_sys
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
limit | Number | 否 | 1 | ||
page | Number | 否 | 1 | ||
search_field | String | 否 | |||
search_value | String | 否 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
total | Number | 否 | 1 | ||
info_list | Array | 否 | |||
sys_uuid | String | 否 | 应用系统uuid | ||
sys_name | String | 否 | 应用系统名称 | ||
dir_name | String | 否 | 二级目录名称 | ||
total_memeber | String | 否 | 成员数量 | ||
current_level | String | 否 | 当前运行等级 | ||
random_str | String | 否 | 随机串 | ||
can_del | Number | 当前用户是否有权限删除,0否1是 | 0 | ||
can_up | Number | 当前用户是否有权限修改,0否1是 | 0 | ||
can_op | Number | 当前用户是否有权限操作,0否1是 | 0 | ||
message | String | 否 |
获取列表(附加成员列表)
SDK类名:/resource/AppSystem;
SDK方法名:appSystemMembersList;
URL
/app_sys/get_app_sys_members
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_type | Number | 规则类型,0,文件备份;1,虚机复制;2,整机备份 | |||
os_type | Number | 操作系统类型,0,linux;1,windows | |||
name | String | 过滤项,成员名称 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info_list | Array | ||||
id | String | 唯一id | 1 | ||
label | String | 应用系统名称 | 123 | ||
sys_uuid | String | 应用系统uuid | |||
children | Array | 成员列表 | 2 | ||
id | Number | 唯一id | "@integer(1, 31)" | ||
label | String | 成员名称 | "@integer(1, 31)" | ||
cpu | String | cpu数量 | |||
core_per_sock | String | cpu核心数 | |||
mem_mb | String | 内存 | |||
os_type | Number | 操作系统类型,0,linux;1,windows | 1 | ||
vp_uuid | String | 获取虚机成员列表时返回,虚机对应的平台uuid | |||
vm_uuid | String | 虚机的uuid | |||
vm_ref | String | 虚机成员返回,虚机的id | |||
ip | String | 节点成员返回,节点的控制台地址 | 172.20.2.80 | ||
rep_path | Array | 节点成员返回,节点的复制路径 |
获取单个
SDK类名:/resource/AppSystem;
SDK方法名:describeAppSystem;
URL
/app_sys/: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] 操作成功 | ||
app_sys | Object | 否 | |||
dir_uuid | String | 否 | |||
sys_name | String | 否 | |||
level_cfg | Array | 否 | |||
day | Array | 否 | [0,1,2,3,4,5,6] | ||
periods | Array | 否 | |||
level | Number | 否 | 1 | ||
start_time | String | 否 | 10:10 | ||
end_time | String | 否 | 12:20 | ||
node_uuids | Array | 节点成员uuid | |||
vm_uuid | Array | 虚机成员uuid | |||
vp_vm_list | Object | 虚拟平台虚机列表 | |||
key | Array | key是虚拟平台名称 | 2 | ||
vm_uuid | String | 虚机uuid | |||
vm_ip | String | 虚机ip | 0.0.0.0 | ||
vm_name | String | 虚机名称 | 虚机名称 |
新建
SDK类名:/resource/AppSystem;
SDK方法名:createAppSystem;
URL
/app_sys
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
dir_uuid | String | 否 | 二级目录uuid | 73412DAD-A7A6-4605-A9FF-081495C8800B | |
sys_name | String | 否 | 应用系统名称 | 应用系统name | |
level_cfg | Array | 否 | 运行等级,Array | ||
day | Array | 否 | 星期日(0)到星期六(6) | [0,1,2,3,4,5,6] | |
periods | Array | 否 | |||
level | Number | 否 | 等级分类: A:0, B:1, C:2 | 0 | |
start_time | String | 否 | 开始时间 | 10:10 | |
end_time | String | 否 | 结束时间 | 12:20 | |
node_uuids | Array | 否 | 节点成员 | ["EA52A961-9883-66FE-188B-D7266AD9594B", "09EEA553-C3B8-0D7A-4797-F7A7E2D4FAE1"] | |
vm_uuids | Array | 否 | 虚机成员 | [] |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | [0] 操作成功 |
修改
SDK类名:/resource/AppSystem;
SDK方法名:modifyAppSystem;
URL
/app_sys/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
dir_uuid | String | 否 | |||
sys_name | String | 否 | |||
level_cfg | Array | 否 | |||
day | Array | 否 | [0,1,2,3,4,5,6] | ||
periods | Array | 否 | |||
level | Number | 否 | 1 | ||
start_time | String | 否 | 10:10 | ||
end_time | String | 否 | 12:20 | ||
node_uuids | Array | 否 | ["EF4825D6-7FB3-7961-6271-5E5B2603414D"] | ||
vm_uuids | Array | 否 | ["EF4825D6-7FB3-7961-6271-5E5B2603414D"] | ||
random_str | String | 否 | 上次修改生成的随机串 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | [0] 操作成功 |
删除
SDK类名:/resource/AppSystem;
SDK方法名:deleteAppSystem;
URL
/app_sys
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
sys_uuids | Array | 否 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | |||
fail_list | Array | 否 | |||
code | Number | 否 | 1 | ||
message | String | 否 | |||
sys_uuid | String | 否 | |||
sys_name | String | 否 | |||
success_list | Array | 否 | |||
code | Number | 否 | 1 | ||
message | String | 否 | |||
sys_uuid | String | 否 | |||
sys_name | String | 否 | |||
ret | Number | 否 | 200 |
获取虚机成员列表
SDK类名:/resource/AppSystem;
SDK方法名:getVmList;
URL
/app_sys/vm_list
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
where_args[vp_uuid] | String | 否 | 虚拟平台uuid | ||
search_field | String | 否 | vm_name | ||
search_value | String | 否 | vm_name |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
total | Number | 否 | 1 | ||
info_list | Array | 否 | |||
vp_uuid | String | 否 | |||
vm_name | String | 否 | 虚机1 | ||
vm_uuid | String | 否 | B8566905-411E-B2CD-A742-77B1346D8E34 | ||
ip | String | 导入的虚机ip | |||
message | String | 否 |
查看全部成员列表
SDK方法名:getMembersList;
URL
/app_sys/members_list
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
sys_uuid | String | 应用系统uuid | |||
page | Number | 页数 | |||
limit | Number | 条数 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
app_sys | Object | 应用系统信息 | |||
id | String | 1 | |||
sys_uuid | String | 应用系统uuid | B8566905-411E-B2CD-A742-77B1346D8E34 | ||
sys_name | String | 应用系统名称 | sys_name | ||
info_list | Array | ||||
uuid | String | uuid | B8566905-411E-B2CD-A742-77B1346D8E34 | ||
name | String | 成员名称 | member_name | ||
type | String | 成员类型: 0:节点; 1:虚机 | 0 | ||
ip | String | 节点:管理地址; 虚机:导入ip | 127.0.0.1 | ||
total | Number | 总条数 | 100 | ||
message | String |
------- 恢复管理 -------
URL
/dash/recovery
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
获取接管列表
SDK类名:/recovery/Recovery;
SDK方法名:recoveryList;
URL
/recovery
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | 页数 | |||
limit | Number | 条数 | |||
type | Number | 规则类型: 5:整机备份; 11:虚机备份; 77:应用容灾; | |||
search_field | String | 过滤字段: sys_name:应用系统名称; rule_name:规则名称; wk_node_name:工作机名称; | |||
search_value | String | 过滤值: | |||
wk_status_filter | String | 工作机状态过滤 ONLINE;在线; OFFLINE:离线; | |||
tgt_status_filter | String | 目标虚机状态过滤: ONLINE;在线; OFFLINE:离线; | |||
failback_status_filter | Number | 接管状态过滤: 未接管:0; 切换中:1; 已接管:2; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
data | Object | ||||
info_list | Array | ||||
rule_uuid | String | 规则uuid | |||
rule_name | String | 规则名称 | |||
rule_type | String | 整机备份:5;虚机复制11 | |||
sys_uuid | String | 应用系统uuid | |||
sys_name | String | 应用系统名称 | |||
wk_uuid | String | 工作机节点uuid 或 虚机uuid | |||
wk_node_name | String | 工作机节点名称 或虚机名称 | |||
wk_ip | String | 工作机数据地址 | |||
wk_config_addr | String | 工作机管理地址 | |||
wk_os_type | Number | 工作机系统类型: 0:linux; 1:windows; | 0 | ||
tgt_name | String | 目标虚机名称 | |||
can_failover | Number | 允许接管 | 0 | ||
can_failback | Number | 允许回切 | 0 | ||
in_failover_switch | Number | 整机备份,是否开启增量回切功能: 0:否; 1:是; | 0 | ||
in_failover_settings | Object | 整机增量回切设置 | |||
virtual_cidr | String | 接管虚机本机CIDR | |||
virtuai_gateway | String | 接管虚机本机网关 | |||
virtual_ip | String | 管理地址 | |||
virtual_port | Number | 管理端口 | |||
virtual_data_ip | String | 数据地址 | |||
oph_policy | Number | 孤儿文件处理: 0:不处理; 1:删除 | 0 | ||
data_path | Array | 接管机的目录。 | |||
rc_dir | Array | 要恢复到工作机的目录 | |||
excl_dir | Array | 排除路径 | |||
failover_uuid | String | (整机备份)增量回切uuid,用来获取回切日志 | |||
total | Number | 100 | |||
message | String | ||||
code | Number | 0 | |||
ret | Number | 200 | |||
msg | String |
获取接管规则状态(工作机、上次运行时间、回切)
SDK类名:/recovery/Recovery;
SDK方法名:recoveryStatus;
URL
/recovery/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuids | Array |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 | |||
status | Array | ||||
rule_uuid | String | 规则uuid | |||
status | String | 工作机节点/虚机 状态 | |||
last_success_time | String | 上次规则成功执行时间 | |||
last_success_drill_time | String | 上次成功验证时间 | |||
failover_status | String | 增量回切状态: TMP_FAILOVER:临时接管中 FAILOVERING:回切中; FAILOVER_SUCCESS:回切成功; FAILOVER_FAILED:回切失败; FAILOVER_NOT_START:未启动回切; FAILOVER_STARTING:启动回切中; | |||
faliover_progress | String | 增量回切百分比 | |||
in_failover_switch | Number | 整机备份,是否开启增量回切功能: 0:否; 1:是; | |||
in_failover_settings | Object | 上次增量回切的设置 | |||
virtual_cidr | String | 接管虚机本机CIDR | |||
virtuai_gateway | String | 接管虚机本机网关 | |||
virtual_ip | String | 管理地址 | |||
virtual_port | Number | 管理端口 | |||
virtual_data_ip | String | 数据地址 | |||
oph_policy | Number | 孤儿文件处理: 0:不处理; 1:删除 | |||
data_path | Array | 接管机的目录。 | |||
rc_dir | Array | 要恢复到工作机的目录 | |||
excl_dir | Array | 排除路径 | |||
tgt_vm_name | String | 目标虚机名称 | |||
failback_status | Number | 接管状态: 0:未接管; 1:切换中; 2:已接管; 目前只应用容灾规则显示 |
------- 批量任务 -------
URL
/dash/batch_task
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
任务列表
SDK类名:/taskCenter/BatchTask;
SDK方法名:batchTaskList;
URL
/batch_task
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
limit | Number | 每页条数 | |||
page | Number | 页数 | |||
type | Number | 否 | 任务类型: 0:文件复制 1:虚机复制 2:整机复制 不传默认所有类型 | ||
like_args[xxx] | String | like_args[batch_name] = '.....' |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] success | |||
info_list | Array | ||||
batch_uuid | String | 批量任务uuid | |||
batch_name | String | 任务名称 | 任务名称 | ||
batch_type | Number | 任务类型: 0:文件复制 1:虚机复制 2:整机复制 | 0 | ||
member_count | Number | 成员数量 | 2 | ||
status | String | 状态 | FINISH | ||
progress | Number | 进度 | 100 | ||
total | Number | 100 |
任务状态
SDK类名:/taskCenter/BatchTask;
SDK方法名:batchTaskStatus;
URL
/batch_task/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
batch_uuids | Array |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
message | String | ||||
code | Number | 0 | |||
status | Array | ||||
batch_uuid | String | ||||
status | String | FINISH | |||
progress | Number | 100 |
任务操作
SDK类名:/taskCenter/BatchTask;
SDK方法名:{operate}BatchTask;
URL
/batch_task/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
operate | String | 操作名称: start,stop,delete | |||
batch_uuid | String | 是 | 批量任务uuid | ||
delete_tgtvm | Number | 删除虚机复制规则时,判断是否删除目标虚拟机。 1:删除 0:不删除。 | |||
del_policy | String | 删除整机备份规则时,*删除策略,0:不开启;1:开启; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
message | String | ||||
code | Number | 0 | |||
fail_list | Array | ||||
code | String | ||||
message | String | ||||
batch_uuid | String | ||||
success_list | Array | 批量创建虚机复制 时返回列表 | |||
code | String | ||||
message | String | 成功失败信息 | |||
rule_name | String | 虚机复制名称 | |||
rule_uuid | String | 虚机复制uuid | |||
fsp_name | String | 整机备份名称 | |||
fsp_uuid | String | 整机备份uuid | |||
rep_name | String | 复制规则名称 | |||
rep_uuid | String | 复制名称uuid |
------- 总览 -------
URL
/dash/resource_view
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
资源概览(旧)
SDK类名:/dashboard/Dashboard;
SDK方法名:resourceView;
URL
/dashboard/source
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | [0] success | ||
info_list | Array | 否 | 容灾平台资源列表(目前是只有一个容灾平台) | ||
vp_uuid | String | 否 | 容灾平台uuid | ||
vp_name | String | 否 | 容灾平台name | ||
ip | String | 否 | 容灾平台ip(页面显示此ip) | ||
status | String | 否 | 容灾平台状态 | ||
vm_total | String | 否 | 虚机总数 | ||
vm_running | String | 否 | 正在运行的虚机数量 | ||
host_count | String | 否 | 主机数 | ||
storage_count | String | 否 | 存储数 | ||
network_total | String | 否 | 网卡数量 | ||
cpu_total | String | 否 | cpu总核数 | ||
cpu_used | String | 否 | cpu已使用mhz | ||
cpu_mhz | String | CPU mhz总量 | |||
cpu_usage | String | 否 | cpu使用率 | ||
mem_total | String | 否 | 内存总数 | ||
mem_used | String | 否 | 内存占用数 | ||
mem_usage | String | 否 | 内存使用率 | ||
storage_total | String | 否 | 存储总数 | ||
storage_used | String | 否 | 存储使用数 | ||
storage_usage | String | 否 | 存储占用率 | ||
protection_coverage | Object | 否 | 资源保护覆盖率设置(总和为100) | ||
level_a | Number | 否 | 70 | ||
level_b | Number | 否 | 30 | ||
level_c | Number | 否 | 20 | ||
cpu_protection | Array | 否 | cpu保护覆盖率 | ||
level | Number | 否 | A:0,B:1,C:2 | 0 | |
cpu_total | String | 否 | cpu总数(可用资源) | ||
cpu_used | String | 否 | 规则已使用cpu数 | ||
cpu_coverage | Number | cpu覆盖率 | 70 | ||
mem_protection | Array | 否 | 内存保护覆盖率 | ||
level | String | 否 | A:0,B:1,C:2 | ||
mem_total | String | 否 | 内存总量(可用资源) | ||
mem_used | String | 否 | 规则已使用内存数 | ||
mem_coverage | Number | 内存覆盖率 | |||
managed_hosts | Array | 否 | 接管主机资源列表 | ||
name | String | 否 | |||
cpu_total | String | 否 | 100 | ||
cpu_usage | String | 否 | 95 | ||
mem_total | String | 否 | |||
mem_used | String | 否 | |||
ip | String | 否 | |||
connection_state | Number | 否 | Vcenter中,主机的连接状态。 | ||
orch_hosts | Array | 否 | 演练主机资源列表 | ||
name | String | 否 | |||
cpu_total | String | 否 | 100 | ||
cpu_usage | String | 否 | 50 | ||
mem_total | String | 否 | |||
mem_used | String | 否 | |||
ip | String | 否 | |||
connection_state | String | 否 | Vcenter中,主机的连接状态。 | ||
total | Number | 否 | 1 |
资源概览 - 获取资源池列表
SDK方法名:listBackupCenter;
URL
/dashboard/list_backup_center
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
exsi_list | Array | exsi资源池列表 | 5 | ||
vp_uuid | String | 平台uuid | @guid | ||
vp_name | String | 平台名称 | @name | ||
ip | String | 地址 | @ip | ||
vcenter_list | Array | vcenter资源池列表 | 5 | ||
vp_uuid | String | 平台uuid | @guid | ||
vp_name | String | 平台名称 | @name | ||
ip | String | 地址 | @ip |
资源概览 - 获取资源使用率和保护覆盖率
SDK方法名:getBackupCenterInfo;
URL
/dashboard/backup_center_info
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
vp_uuid | String | 是 | 资源池uuid |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
vp_uuid | String | 资源池uuid | @guid | ||
status | String | 平台状态 | |||
vm_total | String | 虚机总数 | @integer(1, 20 ) | ||
vm_running | String | 正在运行的虚机数量 | @integer(1, 10 ) | ||
host_count | String | 主机数量 | @integer(1, 20 ) | ||
storage_count | String | 存储数量 | @integer(1, 20 ) | ||
network_total | String | 网卡总数 | @integer(1, 20 ) | ||
cpu_mhz | String | CPU mhz总量 | @integer(10000, 20000 ) | ||
cpu_used | String | cpu已使用mhz | @integer(1000, 10000 ) | ||
cpu_usage | String | cpu使用率 | @integer(10, 100 ) | ||
cpu_total | String | cpu总核心数 | @integer(1,16 ) | ||
mem_total | String | 内存总数 | @integer(64,128 ) | ||
mem_used | String | 内存占用数 | @integer(1,64 ) | ||
mem_usage | String | 内存使用率 | @integer(10, 100 ) | ||
storage_total | String | 存储总数 | @integer(60, 100 ) | ||
storage_used | String | 存储使用数 | @integer(10, 60 ) | ||
storage_usage | String | 存储占用率 | @integer(10, 100 ) | ||
cpu_protection | Array | cpu保护覆盖率 | 3 | ||
level | String | 分类: A:0,B:1,C:2 | @integer(0, 2) | ||
cpu_total | String | cpu总数(可用资源) | 100 | ||
cpu_used | String | 规则已使用cpu数 | @integer(10, 100 ) | ||
cpu_coverage | String | cpu覆盖率 | @integer(10, 100 ) | ||
mem_protection | Array | 内存保护覆盖率 | 3 | ||
level | String | 分类: A:0,B:1,C:2 | @integer(0, 2) | ||
mem_total | String | 内存总量(可用资源) | 100 | ||
mem_used | String | 规则已使用内存数 | @integer(10, 100 ) | ||
mem_coverage | String | 内存覆盖率 | @integer(10, 100 ) | ||
protection_coverage | Object | 资源保护覆盖率设置(总和为100) | |||
level_a | String | 40 | |||
level_b | String | 35 | |||
level_c | String | 25 |
资源概览 - 获取接管、演练平台列表
SDK方法名:listHosts;
URL
/dashboard/list_hosts
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] success | |||
managed_hosts | Array | 接管主机列表 | 2 | ||
ip | String | @ip | |||
name | String | @name | |||
cpu_mhz | String | @integer(1000,10000) | |||
cpu_total | String | 100 | |||
cpu_used | String | @integer(10, 100) | |||
cpu_usage | String | @integer(10, 100 ) | |||
mem_total | String | 100 | |||
mem_used | String | @integer(10, 100 ) | |||
connection_state | String | 1 | |||
mem_usage | String | @integer(10, 100) | |||
orch_hosts | Array | 演练主机列表 | 4 | ||
ip | String | @ip | |||
name | String | @name | |||
cpu_mhz | String | @integer(1000,10000) | |||
cpu_total | String | 100 | |||
cpu_used | String | @integer(10, 100) | |||
cpu_usage | String | @integer(10, 100 ) | |||
mem_total | String | 100 | |||
mem_used | String | @integer(10, 100 ) | |||
mem_usage | String | @integer(10, 100) | |||
connection_state | String |
设置资源保护覆盖率
SDK类名:/dashboard/Dashboard;
SDK方法名:resourceProtectionCoverage;
URL
/dashboard/resource_protection_coverage
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
vp_uuid | String | 资源池uuid | |||
level_a | Number | 否 | |||
level_b | Number | 否 | |||
level_c | Number | 否 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | |||
ret | Number | 否 | 200 |
任务概览列表
SDK类名:/dashboard/Dashboard;
SDK方法名:taskView;
URL
/dashboard/task
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info_list | Array | ||||
key | Number | 前端要用到的索引 | |||
dir_uuid | String | 二级目录uuid | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
dir_name | String | 二级目录名称 | 二级目录 | ||
level_a | Number | A类数量 | 1 | ||
level_b | Number | B类数量 | 2 | ||
level_c | Number | C类数量 | 3 | ||
app_sys_list | Array | 应用系统列表 | |||
key | String | 前端要用到的索引 | |||
id | Number | 3 | |||
sys_uuid | String | 应用系统uuid | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
sys_name | String | 应用系统名称 | app_sys_name | ||
wk_total_num | Number | 工作机总数 | 1 | ||
wk_online_num | Number | 工作机在线总数 | 0 | ||
bk_total_num | Number | 灾备机总数 | 2 | ||
bk_online_num | Number | 灾备机在线总数 | 2 | ||
slave_num | Number | 从节点数量 | 3 | ||
take_over_num | Number | 接管数(处于“临时切换成功”状态的规则数量) | 2 | ||
rule_num | Number | 规则数量 | 10 | ||
rule_list | Array | 应用系统规则列表 | |||
rule_uuid | String | 规则uuid | |||
group_uuid | String | 规则的group_uuid,可以为null | |||
rule_name | String | 规则名称 | rule_name | ||
wk_name | String | 工作机名称 | wk_name | ||
wk_uuid | String | 工作机uuid | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
wk_ip | String | 工作机ip | 172.20.2.200 | ||
wk_os_version | String | 工作机操作系统类型 | Windows Server 2012 R2 | ||
wk_status | String | 工作机状态 | ONLINE | ||
bk_name | String | 灾备机/从节点 名称 | wk_name | ||
bk_uuid | String | 灾备机/从节点 uuid | B8566905-411E-B2CD-A742-77B1346D8E84 | ||
bk_ip | String | 灾备机/从节点 ip | 172.20.2.200 | ||
bk_os_version | String | 灾备机/从节点 操作系统信息 | Windows Server 2012 R2 | ||
bk_status | String | 灾备机/从节点 状态 | OFFLINE | ||
rule_type | String | 规则类型:ha,ffo,coopy,vp_rep | ffo | ||
backup_num | Number | 备份数 | 10 | ||
backup_num_effective | Number | 有效备份数 | 10 | ||
status | String | 规则状态(高可用后端返回的是主节点上的规则状态) | RUN | ||
master_uuid | String | HA 规则,主节点uuid | |||
fake_rule | Number | 是否为空规则(只显示应用系统成员): 1:是;0:否 | 0 | ||
can_start | Number | 启动 | 1 | ||
can_stop | Number | 停止 | 1 | ||
can_recovery | Number | 恢复(暂未用到) | 1 | ||
can_failover | Number | 接管 | 1 | ||
can_failback | Number | 回切 | 1 | ||
children | Array | ||||
wk_total_num | Number | 工作机总数 | 1 | ||
wk_online_num | Number | 工作机在线数 | 1 | ||
rule_num | String | 二级目录规则总数 | |||
wk_num | Number | 生产节点数 | |||
bk_num | Number | 灾备节点数 |
------- 其他 -------
URL
/dash/bc/other
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
统计报表
SDK类名:/common/GeneralInterface
SDK方法名:listStatisticsReport;
URL
/statistics/report
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
start_time | String | 否 | 2019-11 | ||
end_time | String | 否 | 2020-04 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 否 | 200 | ||
msg | String | 否 | |||
data | Object | 否 | |||
code | Number | 否 | 0 | ||
message | String | 否 | [0] 操作成功。 | ||
info_list | Array | 否 | |||
time | String | 否 | 2020-04 | ||
app_sys | Number | 否 | 系统接入(创建应用系统数) | 1 | |
node | Number | 否 | 服务器接入(创建节点数) | 1 | |
vp_rep | Number | 否 | 虚机备份(虚机复制数) | 1 | |
ffo | Number | 否 | 整机备份数(ffo) | 1 | |
vp_drill | Number | 否 | 验证数(虚机演练数) | 1 | |
take_over | Number | 否 | 接管数 | 1 | |
app_sys_total | Number | 否 | 当前筛选条件下总的 | 51 | |
node_total | Number | 否 | 22 | ||
vp_rep_total | Number | 否 | 21 | ||
ffo_total | Number | 否 | 25 | ||
vp_drill_total | Number | 否 | 44 | ||
take_over_total | Number | 否 | 30 |
应急演练,获取华云平台登录虚机地址
SDK类名:/resource/VirtualizationSupport;
SDK方法名: archerVmConsole;
URL
/vp/platform/archer_vm_console
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuid | String | 演练规则uuid |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
console_url | String | 登录虚机地址 |
------ 整机副本 ------
URL
/------ 整机副本 ------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
自动注册节点(底层调用)
SDK方法名:autoRegisterNode;
URL
/api/client/rest_rpc/node
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
uuid | String | 整机副本规则uuid | |||
vp_uuid | String | 虚拟平台地址 | |||
vm_uuid | String | 目标虚机uuid | |||
node_name | String | 节点名称 | |||
os_type | Number | 系统类型: 0:linux; 1:windows; | 1 | ||
os_user | String | 用户名 | |||
os_pwd | String | 密码,AES加密(同rpc.node_os_auth) | |||
cc_ip | String | 控制台ip | |||
config_addr | String | 节点管理地址 | |||
config_port | Number | 节点管理端口 | |||
root | String | 节点安装目录(用来拼接各种目录路径) | |||
disk_limit | Number | 是 | 磁盘使用上限 | ||
mem_limit | Number | 内存使用上限 | |||
disk_free_space_limit | Number | 磁盘剩余空间阈值 | |||
cache_path | String | 数据缓存目录(存在就用,不存在仍然用root拼接) | |||
log_path | String | 日志目录(存在就用,不存在仍然用root拼接) |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] success |
整机副本 - 新建
SDK类名:/fullMachineCopy/FullMachineCopy;
SDK方法名:createFullMachineCopy;
URL
/full_machine_copy
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_backup | Object | ||||
fsp_type | Number | 固定传21:整机副本 | 21 | ||
wk_data_type | Number | 固定传0:块设备 | 0 | ||
bk_data_type | Number | 固定传21:华云平台 | 21 | ||
fsp_name | String | 规则名称 | |||
wk_uuid | String | 工作机uuid | |||
bk_uuid | String | 灾备机uuid | |||
data_ip_uuid | String | 数据地址uuid | |||
timeout | Number | 超时阈值 | 0 | ||
wk_path | Array | 原路径(参考整机备份块设备) | |||
bk_path | Array | 灾备路径 | |||
resource_settings | Object | 虚机设置 | |||
tgt_uuid | String | 目标平台uuid | |||
new_dc | String | 数据中心 | |||
new_dc_mor | String | 数据中心标识 | |||
new_host | String | 主机名称 | |||
new_ds | String | 数据存储 | |||
create_vm_type | Number | 创建虚机策略: 0:指定节点; 1:系统调配; | |||
vm_list | Array | ||||
disk_list | Array | 磁盘信息 | |||
boot_index | String | 引导顺序 | |||
file_name | String | 磁盘名称 | |||
new_ds | String | 存储名称 | |||
size | String | 磁盘大小 | |||
is_ignored | String | 磁盘信息-是否忽略: 选中为0,不选为1 | |||
disk_name | String | 磁盘信息-名称 从RPC接口返回的虚机磁盘名称,下发RPC仅需要最后磁盘名称 | |||
disk_path | String | 磁盘信息-路径 Vmware暂时传 空串,Hyper-V传用户选的磁盘路径(结尾带) | |||
id | String | hyper-v有,磁盘uuid | |||
disk_provision_type | Number | 磁盘置备类型(仅限目标平台为vmware): 0:源机磁盘配置; 1:为精简置备; 2:为厚置备延迟置零; 3:为厚置备置零; | |||
vm_name | String | 工作机 | |||
new_vm_name | String | 目标机名称 | |||
new_vm_hostname | String | 目标机主机名 | |||
custom_config | Number | 自定义设置: 是否勾选自定义设置: 0:否; 1:是; | |||
cpu | String | 自定义设置:处理器数量 | |||
core_per_sock | String | 自定义设置:处理器核心 | |||
mem_mb | String | 自定义设置:内存 | |||
dynamic_mem | String | 自定义设置:默认传0即可 | |||
networks | Array | 自定义设置:网卡信息 | |||
source_network_name | String | 源端网卡名称 | |||
mac_address | String | 源端mac地址 | |||
keep_mac | String | 是否保留MAC(华云传'') | |||
network_id | String | 目标平台网卡ID | |||
network_name | String | 目标平台网卡名称 | |||
subnet_name | String | 子网名称(华云) | |||
auto_ip | Boolean | 自动ip开关: true:开; false:关; (华云) | |||
ip | String | ip地址(华云) | |||
security_group_name | String | 安全组名称(华云) | |||
gateway | String | 网关(华云平台参数) | |||
is_defroute | Boolean | 是否默认网关(华云平台参数) | false | ||
auto_register | Number | 是否自动注册节点: 0:否; 1:是; | |||
node_name | String | 自动注册目标机节点名称 | |||
node_lic_list | Array | 节点绑定许可列表 | |||
node_cache_path | String | 节点数据缓存路径 | |||
node_log_path | String | 节点日志路径 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 |
整机副本 - 修改
方法名:modifyFullMachineCopy;
URL
/full_machine_copy/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_backup | Object | ||||
fsp_type | Number | 21 | |||
wk_uuid | String | ||||
bk_uuid | String | ||||
data_ip_uuid | String | ||||
timeout | Number | 0 | |||
wk_path | Array | ||||
bk_path | Array | ||||
resource_settings | Object | ||||
tgt_uuid | String | ||||
new_dc | String | ||||
new_host | String | ||||
new_ds | String | ||||
new_dc_mor | String | ||||
vm_list | Array | ||||
disk_list | Array | ||||
boot_index | String | ||||
file_name | String | ||||
new_ds | String | ||||
size | String | ||||
is_ignored | String | ||||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
disk_provision_type | Number | 1 | |||
vm_name | String | ||||
new_vm_name | String | ||||
custom_config | Number | 1 | |||
cpu | String | ||||
core_per_sock | String | ||||
mem_mb | String | ||||
dynamic_mem | String | ||||
networks | Array | ||||
source_network_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | ||||
is_defroute | Boolean | ||||
fsp_name | String | ||||
bk_data_type | Number | 21 | |||
wk_data_type | Number | 0 | |||
auto_register | Number | 1 | |||
node_name | String | ||||
random_str | String | 随机字串 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
message | String | ||||
code | Number | 0 |
整机副本 - 删除
方法名:deleteFullMachineCopy;
URL
/full_machine_copy
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_uuids | Array | 规则uuid数组 | |||
del_policy | String | 删除策略: 0:不开启; 1:开启; | |||
force | Number | 是否强制删除: 0:否; 1:是; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test1 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test2 |
整机副本 - 获取详情
方法名:describeFullMachineCopy;
URL
/full_machine_copy/:uuid([A-F0-9-]+)
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
message | String | ||||
fsp_backup | Object | ||||
bk_ip | String | 0.0.0.0 | |||
bkup_one_time | Number | 1515568566 | |||
wk_port | String | 26821 | |||
mirr_open_type | String | 0 | |||
wk_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
secret_key | String | ||||
bk_data_type | Number | 0 | |||
bkup_policy | Number | 0 | |||
wk_path | String | ||||
bk_path | String | ||||
fsp_name | String | rrrrr | |||
mirror_method | String | 0 | |||
bk_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
wk_data_type | Number | 1 | |||
mirr_file_check | String | 0 | |||
excl_path | String | ||||
monitor_type | Number | 0 | |||
band_width | String | 303:00-14:002m | |||
service_uuid | String | ||||
backup_type | String | @pick([0, 1, 2]) | |||
bkup_schedule | Array | ||||
sched_day | String | @integer(1, 31) | |||
sched_time_end | String | @time('HH:mm') | |||
limit | String | @integer(1, 64) | |||
sched_gap_min | String | @integer(1, 64) | |||
sched_time | String | @time('HH:mm') | |||
sched_every | Number | 2 | |||
sched_time_start | String | @time('HH:mm') | |||
compress | String | 0 | |||
move_type | String | 0 | |||
wk_ip | String | 0.0.0.0 | |||
mirr_sync_attr | String | 1 | |||
bk_port | String | 26831 | |||
fsp_wk_shut_flag | String | 2 | |||
failover | Number | 1 | |||
mirr_sync_flag | String | 0 | |||
random_str | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
sync_item | String | C: | |||
net_mapping | Array | ||||
net_mapping_type | String | 2 | |||
encrypt_switch | String | 0 | |||
fsp_type | String | ||||
cbt_switch | Number | 1 | |||
threshold_vaild_byte | Number | 1 | |||
advanced_policy | Object | ||||
bk_cdp | Number | 1 | |||
execute_interval | Number | 1 | |||
cdp_detail | Number | 1 | |||
cdp_daily | Number | 1 | |||
cdp_switch | Number | 1 | |||
cdp_param | String | ||||
storage | Object | ||||
type | String | ||||
path | String | ||||
vp_uuid | String | ||||
storage_uuid | String | ||||
data_ip_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
thread_num | Number | 1 | |||
in_failover_switch | Number | 1 | |||
in_failover_settings | Object | ||||
virtual_cidr | String | ||||
virtuai_gateway | String | ||||
virtual_ip | String | ||||
virtual_port | Number | 1 | |||
virtual_data_ip | String | ||||
oph_policy | Number | 1 | |||
data_path | Array | ||||
rc_dir | Array | ||||
excl_dir | Array | ||||
auto_register | Number | 自动注册目标虚机节点 | 0 | ||
node_name | String | 目标虚机节点名称 | |||
node_uuid | String | 目标虚机节点uuid(成功注册后才有值) | |||
code | Number | 0 |
整机副本 - 获取列表
SDK方法名:listFullMachineCopy;
URL
/full_machine_copy
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
search_field | String | ||||
search_value | String | ||||
limit | Number | 10 | |||
page | Number | 1 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
info_list | Array | ||||
fsp_uuid | String | 规则uuid | @pick(["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3", "0DD4E727-70AB-62C6-BEB5-D012DFAE46E4"]) | ||
fsp_name | String | 规则名称 | |||
wk_uuid | String | 工作机uuid | 7AD64D7A-7D1D-AC51-5DF1-29A58345A288 | ||
wk_node_name | String | 工作机名称 | @pick(["Smith", "Will", "Nary"]) | ||
resource_settings | Object | 虚机设置参数 | |||
vm_list | Array | ||||
new_vm_name | String | 目标机名称 | |||
tgt_name | String | 目标平台名称 | |||
vm_name | String | 目标虚机名称 | |||
username | String | 所有者用户名 | @pick(["admin", "user", "super"]) | ||
can_op | String | ||||
can_up | String | ||||
can_del | Number | 1 | |||
total | Number | 100 | |||
count | Number | 10 | |||
code | Number | 0 | |||
message | String |
整机副本 - 获取状态
SDK方法名:listFullMachineCopyStatus;
URL
/full_machine_copy/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_uuids | Array | ||||
force_refresh | Number | 强制刷新: 0:否; 1:是; | 0 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
status | Object | ||||
status | String | STOP | |||
db_status | String | ||||
fsp_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
f_total | String | 0 | |||
progress | String | 0 | |||
target_vm_ip | String | 目标机ip | |||
host_name | String | 主机名 | |||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 |
整机副本 - 操作
SDK方法名:operateFullMachineCopy;
URL
/full_machine_copy/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_uuids | Array | ||||
operate | String | start:启动; stop:停止; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 11110001 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test2 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test1 |
------ 应用容灾 ------
URL
/------ 应用容灾 ------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
应用容灾 - 新建
SDK类名:/appContinuity/AppContinuity;
SDK方法名:createAppContinuity;
URL
/app_continuity
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rep_name | String | 规则名称 | |||
biz_grp_list | Array | 绑定业务组列表 | |||
wk_uuid | String | 工作机uuid | |||
vp_uuid | String | 目标平台 | |||
vm_name | String | 目标虚机名称 | |||
vm_ref | String | 目标虚机ID | |||
bk_uuid | String | 目标节点 | |||
data_ip_uuid | String | 目标节点数据地址uuid | |||
wk_path | Array | 工作路径 | |||
bk_path | Array | 目标路径 | |||
excl_path | Array | 排除路径 | |||
mirr_file_check | Number | 校验方式: 0:严格校验; 1:时间校验; | |||
mirr_sync_flag | Number | 错误处理方式: 0:遇到错误停止; 1:写日志; | |||
mirr_open_type | Number | 文件打开方式: 0:普通文件; 1:自动选择; 2:MFT; | |||
mirr_sync_attr | Number | 文件安全属性: 0:不同步; 1:同步; | |||
encrypt_switch | Number | 加密开关: 0:关; 1:开; | |||
secret_key | String | 加密秘钥 | |||
compress | Number | 压缩等级: 0:关; 1:极速压缩; 2:普通压缩; 3:快速压缩; 4:均衡压缩; | |||
oph_policy | Number | 孤儿文件策略: 0:不处理; 1:删除; 2:移动到指定路径; 6:移动到指定路径并删除; | |||
oph_path | String | 孤儿文件指定路径 | |||
thread_num | Number | 并行任务数 | |||
bkup_schedule | Array | 快照策略(参照整机备份-周期性备份策略) | |||
sched_day | Array | 哪几天 | |||
sched_time | Array | 哪几点 | |||
sched_every | Number | 0:每天; 1:每周: 2:每月; 3:每隔; | |||
limit | String | 快照保留期限 | |||
sched_gap_hour | Number | 每隔 - 间隔时间(小时),必须能够被24整除 | |||
sched_time_start | String | 每隔,开始时间 | |||
band_width | String | 带宽控制,格式: 303:00-14:002m,202:00-15:0080m(block也有) | |||
take_over_settings | Object | 接管配置 | |||
disk_list | Array | 目标虚机磁盘列表 | |||
file_name | String | 磁盘名称 | |||
size | String | 磁盘大小 | |||
new_ds | String | 存储名称 | |||
boot_index | Number | 引导顺序 | |||
networks | Array | 目标虚机网卡列表 | |||
network_name | String | 名称 | |||
network_id | String | ID | |||
subnet_name | String | 子网名称 | |||
auto_ip | Boolean | 自动ip开关: true:开; false:关; (华云平台参数) | |||
ip | String | ip地址 | |||
security_group_name | String | 安全组名称 | |||
gateway | String | 网关(华云平台参数) | |||
is_defroute | Boolean | 是否默认网关(华云平台参数) | false | ||
cpu | String | 目标机处理器数量 | |||
core_per_sock | String | 目标机处理器核心数 | |||
mem_mb | String | 目标机内存 | |||
verify_settings | Object | 验证设置 | |||
add_drill | Number | 是否开启验证:、 0:否; 1:是; | |||
auto | String | 自动验证: 自动:1; 手动:0; | |||
drill_plat_uuid | String | 演练平台uuid | |||
create_vm_type | Number | 创建虚机策略: 0:指定节点; 1:系统调配; | 1 | ||
hostname | String | 主机名称 | |||
vm_list | Array | 虚机列表 | |||
vm_name | String | 虚机名称(目标虚机) | |||
orch_vm_name | String | 演练新虚机名称 | |||
scripts_type | Number | 脚本验证的方式: 0:ping; 1:tcp端口验证; 2:脚本验证(默认为0); | |||
scripts | String | 验证内容 | |||
custom_config | Number | 是否开启自定义验证: 0:否; 1:是 | |||
orch_disks | Array | ||||
file_name | String | 名称 | |||
size | String | 大小 | |||
new_ds | String | 存储 | |||
boot_index | String | 引导顺序 | |||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
orch_networks | Array | ||||
source_network_name | String | 源端网卡名称(目标虚机) | |||
mac_address | String | 远端网卡mac地址(华云平台传'') | |||
keep_mac | String | 保留mac(华云平台传'') | |||
network_name | String | 目标平台(和演练平台是同一个)网卡名称,不可以修改 | |||
network_id | String | 目标平台(和演练平台是同一个)网卡id,不可以修改 | |||
subnet_name | String | 子网名称(华云平台参数) | |||
ip | String | ip地址(华云平台参数) | |||
security_group_name | String | 安全组名称(华云平台参数) | |||
gateway | String | 网关(华云平台参数) | |||
is_defroute | Boolean | 是否默认网关(华云平台参数) | false | ||
orch_cpu_num | String | 演练虚机cpu个数 | |||
orch_cores_per_cpu_num | String | 演练虚机cpu核心数 | |||
orch_memory_mb | String | 演练虚机内存 | |||
is_continue_policy | Number | 规则停止后继续定时快照: 0:关; 1:开; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 |
应用容灾 - 修改
SDK方法名:modifyAppContinuity;
URL
/app_continuity/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rep_name | String | ||||
wk_uuid | String | ||||
vp_uuid | String | ||||
biz_grp_list | Array | ||||
vm_name | String | ||||
vm_ref | String | ||||
bk_uuid | String | ||||
data_ip_uuid | String | ||||
wk_path | Array | ||||
bk_path | Array | ||||
excl_path | Array | ||||
mirr_file_check | Number | 1 | |||
mirr_sync_flag | Number | 1 | |||
mirr_open_type | Number | 1 | |||
mirr_sync_attr | Number | 1 | |||
encrypt_switch | Number | 1 | |||
secret_key | String | ||||
compress | Number | 1 | |||
bkup_schedule | Array | ||||
sched_day | Array | ||||
sched_time | Array | ||||
sched_every | Number | 1 | |||
limit | String | ||||
band_width | String | ||||
verify_settings | Object | ||||
add_drill | Number | 1 | |||
auto | String | ||||
drill_plat_uuid | String | ||||
vm_list | Array | ||||
vm_name | String | ||||
orch_vm_name | String | ||||
scripts_type | Number | 1 | |||
scripts | String | ||||
custom_config | Number | 1 | |||
orch_disks | Array | ||||
file_name | String | ||||
size | String | ||||
new_ds | String | ||||
boot_index | String | ||||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
orch_networks | Array | ||||
source_network_name | String | ||||
network_name | String | ||||
network_id | String | ||||
subnet_name | String | ||||
ip | String | ||||
security_group_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
gateway | String | ||||
is_defroute | Boolean | ||||
orch_cpu_num | String | ||||
orch_cores_per_cpu_num | String | ||||
orch_memory_mb | String | ||||
take_over_settings | Object | ||||
disk_list | Array | ||||
file_name | String | ||||
size | String | ||||
new_ds | String | ||||
boot_index | Number | 1 | |||
networks | Array | ||||
network_name | String | ||||
network_id | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | ||||
is_defroute | Boolean | ||||
cpu | String | ||||
core_per_sock | String | ||||
mem_mb | String | ||||
random_str | String | 随机字串 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 |
应用容灾 - 删除
方法名:deleteAppContinuity;
URL
/app_continuity
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rep_uuids | Array | ||||
force | Number | 1 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
rep_uuid | String | @guid | |||
rep_name | String | test1 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
rep_uuid | String | @guid | |||
rep_name | String | test2 |
应用容灾 - 获取详情
方法名:describeAppContinuity;
URL
/app_continuity/:uuid([A-F0-9-]+)
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
message | String | ||||
code | Number | 0 | |||
app_continuity | Object | ||||
rep_name | String | ||||
wk_uuid | String | ||||
vp_uuid | String | ||||
biz_grp_list | Array | ||||
vm_name | String | ||||
vm_ref | String | ||||
bk_uuid | String | ||||
data_ip_uuid | String | ||||
wk_path | Array | ||||
bk_path | Array | ||||
excl_path | Array | ||||
mirr_file_check | Number | 1 | |||
mirr_sync_flag | Number | 1 | |||
mirr_open_type | Number | 1 | |||
mirr_sync_attr | Number | 1 | |||
encrypt_switch | Number | 1 | |||
secret_key | String | ||||
compress | Number | 1 | |||
bkup_schedule | Array | ||||
sched_day | Array | ||||
sched_time | Array | ||||
sched_every | Number | 1 | |||
limit | String | ||||
band_width | String | ||||
verify_settings | Object | ||||
add_drill | Number | 1 | |||
auto | String | ||||
drill_plat_uuid | String | ||||
vm_list | Array | ||||
vm_name | String | ||||
orch_vm_name | String | ||||
scripts_type | Number | 1 | |||
scripts | String | ||||
custom_config | Number | 1 | |||
orch_disks | Array | ||||
file_name | String | ||||
size | String | ||||
new_ds | String | ||||
boot_index | String | ||||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
orch_networks | Array | ||||
source_network_name | String | ||||
network_name | String | ||||
network_id | String | ||||
subnet_name | String | ||||
ip | String | ||||
security_group_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
orch_cpu_num | String | ||||
orch_cores_per_cpu_num | String | ||||
orch_memory_mb | String | ||||
take_over_settings | Object | ||||
disk_list | Array | ||||
file_name | String | ||||
size | String | ||||
new_ds | String | ||||
boot_index | Number | 1 | |||
networks | Array | ||||
network_name | String | ||||
network_id | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
cpu | String | ||||
core_per_sock | String | ||||
mem_mb | String | ||||
failover_script_uuid | String | 切换(接管)脚本uuid | |||
failback_script_uuid | String | 回切(回退)脚本uuid |
应用容灾 - 列表
SDK方法名:listAppContinuity;
URL
/app_continuity
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
limit | Number | ||||
page | Number |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
info_list | Array | 2-4 | |||
rep_uuid | String | 规则uuid | @uuid | ||
rep_name | String | 规则名称 | rep-@first | ||
wk_uuid | String | 工作机uuid | @uuid | ||
wk_node_name | String | 工作机名称 | 工作机-@cname | ||
wk_ip | String | ||||
bk_uuid | String | ||||
bk_ip | String | ||||
vp_uuid | String | 目标平台uuid | @uuid | ||
vp_name | String | 目标平台名称 | target-plat-@first | ||
vp_config_addr | String | ||||
vm_name | String | 目标虚机名称 | target-vm-@first | ||
vm_ref | String | 目标虚机ID | |||
user_uuid | String | ||||
username | String | @pick(["admin", "user", "super"]) | |||
can_del | Number | 1 | |||
can_op | String | ||||
can_up | String | ||||
total | Number | 100 | |||
count | Number | 10 | |||
code | Number | 0 | |||
message | String |
应用容灾 - 操作
SDK方法名: operateAppContinuity;
URL
/app_continuity/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rep_uuids | Array | ||||
operate | String | start:启动; stop:停止; snapshot_immediately:立即快照; snapshot_delete:删除快照; failover:接管; failback:回退; modify_script:脚本管理(接管列表调用) | |||
snap_name | String | 快照时间点(删除快照参数); | |||
snap_point | String | 快照时间点(接管参数); | |||
failover_script_uuid | String | 切换(接管)脚本uuid | |||
failback_script_uuid | String | 回切(回退)脚本uuid |
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方法名:listAppContinuityStatus;
URL
/app_continuity/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rep_uuids | Array | ||||
force_refresh | Number | 强制刷新: 0:否; 1:是; | 0 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
status | Object | ||||
rep_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
status | String | STOP | |||
progress | String | 0 | |||
latency | Number | 复制延迟,单位ms | |||
target_vm_ip | String | 目标虚机ip | |||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 |
--- 一级副本(复用应急演练) ---
URL
/------- 一级副本 -------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
一级副本 - 新建
参照 虚机演练规则;
SDK类名:/replica/First;
SDK方法名:createFirstReplica;
URL
/replica/first
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_name | String | 虚机名称 | |||
rule_type | Number | 固定传5 | 0 | ||
vp_uuid | String | 目标平台uuid | |||
datacenter | String | 目标平台数据中心 | |||
hostname | String | 目标平台主机 | |||
datastore | String | 目标平台存储 | |||
vm_list | Array | 工作机列表 | |||
vm_name | String | 虚机(工作机)名称 | |||
new_vm_name | String | 新虚机名称 | |||
new_vm_hostname | String | 新虚机主机名 | |||
cpu | Number | 处理器数量 | 1 | ||
core_per_sock | Number | 处理器核心数量 | 1 | ||
mem_mb | Number | 内存大小 | 1024 | ||
original_rule_uuid | String | 应用容灾uuid | |||
wk_uuid | String | 应用容灾,工作机uuid | |||
bk_uuid | String | 应用容灾,目标节点uuid | |||
time | String | 备份点 | |||
ver_sig | String | 备份点信息 | |||
disk_list | Array | 自定义磁盘信息 | |||
datastore | String | ||||
new_ds | String | ||||
is_ignored | Number | 1 | |||
size | String | ||||
boot_index | Number | 1 | |||
disk_dir | String | ||||
disk_name | String | ||||
id | String | ||||
networks | Array | 自定义网卡信息 | |||
source_network_name | String | ||||
source_network_id | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
ip_address | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | true | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | (华云平台参数) 网关 | |||
is_defroute | Boolean | (华云平台参数) 是否默认网关 | false | ||
os_type | Number | 1 | |||
vm_ref | String | '' | |||
scripts | String | '' | |||
scripts_type | Number | 0 | |||
bk_path | String | '' | |||
src_uuid | String | ||||
data_ip_uuid | String | ||||
bk_type | Number | 0 | |||
bucket_ | String | ||||
sto_uuid | String | ||||
bucket_path | String | ||||
new_flavor_id | String | ||||
auto | Number | 0 | |||
quick_back | Number | 1 | |||
backup_type | String | i | |||
lan_free | Number | 23 | |||
del_bkup_data | Number | 0 | |||
automate | Number | 0 | |||
auto_shutdown | Number | 1 | |||
bkup_policy | Number | ||||
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 | |||
new_network_id | String | ||||
new_network_name | String | ||||
create_vm_type | Number | 创建虚机策略: 0:指定节点; 1:系统调配; |
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 |
一级副本 - 获取列表
SDK方法名:listFirstReplica;
URL
/replica/first
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | ||||
limit | Number |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info_list | Array | ||||
group_uuid | String | 组uuid | @uuid | ||
rule_name | String | 虚机名称 | Donna Smith | ||
rule_uuid | String | 副本uuid | E3EdA75B-Db84-c4EF-75d7-DfbaacdCB5eF | ||
vp_uuid | String | 虚拟平台uuid | DcDd4A7d-2Ae3-bFd7-d346-14F0A9Fad77C | ||
vp_name | String | 虚拟平台名称 | Mary Jackson | ||
vp_type | Number | 虚拟平台类型 | 0 | ||
wk_uuid | String | 工作机uuid | |||
wk_node_name | String | 工作机名称 | wk-@first | ||
time | String | 备份点 | @time | ||
username | String | 所有者 | Daniel Smith | ||
can_del | Number | 1 | |||
can_up | Number | ||||
can_op | Number | ||||
vp_config_addr | String | 虚拟平台管理地址 | |||
hostname | String | 主机名称 | |||
datastore | String | 存储 | |||
total | Number | 1 |
一级副本 - 获取详情
UUID为group_uuid;
SDK方法名:describeFirstReplica;
URL
/replica/first/: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] 操作成功 | |||
first_replica | 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 |
一级副本 - 修改
UUID为group_uuid
SDK方法名:modifyFirstReplica;
URL
/replica/first/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_name | String | ||||
rule_type | Number | 0 | |||
vp_uuid | String | ||||
auto | Number | 0 | |||
vm_list | Array | ||||
new_vm_name | String | ||||
vm_ref | String | '' | |||
cpu | Number | 1 | |||
ver_sig | String | ||||
core_per_sock | Number | 1 | |||
mem_mb | Number | 1024 | |||
scripts | String | '' | |||
bk_uuid | String | ||||
bk_path | String | '' | |||
time | String | ||||
original_rule_uuid | String | ||||
scripts_type | Number | 0 | |||
os_type | Number | 1 | |||
wk_uuid | String | ||||
src_uuid | String | ||||
data_ip_uuid | String | ||||
bk_type | Number | 0 | |||
bucket_ | String | ||||
sto_uuid | String | ||||
bucket_path | String | ||||
disk_list | Array | ||||
datastore | String | ||||
new_ds | String | ||||
is_ignored | Number | 1 | |||
size | String | ||||
boot_index | Number | 1 | |||
disk_dir | String | ||||
disk_name | String | ||||
id | String | ||||
networks | Array | ||||
source_network_name | String | ||||
source_network_id | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
ip_address | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | true | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | ||||
is_defroute | Boolean | ||||
new_flavor_id | String | ||||
vm_name | String | ||||
quick_back | Number | 1 | |||
backup_type | String | i | |||
lan_free | Number | 23 | |||
del_bkup_data | Number | 0 | |||
automate | Number | 0 | |||
auto_shutdown | Number | 1 | |||
bkup_policy | Number | 1 | |||
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 | |||
new_network_id | String | ||||
new_network_name | String | ||||
datastore | String | ||||
hostname | String | ||||
datacenter | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 |
一级副本 - 获取状态
SDK方法名:listFirstReplicaStatus;
URL
/replica/first/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuids | Number | ||||
force_refresh | Number | 强制刷新 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
count | String | 1 | |||
message | String | ||||
code | Number | 0 | |||
status | Array | ||||
status | String | @pick(VP_START, MIRROR) | |||
progress | Number | 0-100 | |||
rule_uuid | String | E3EdA75B-Db84-c4EF-75d7-DfbaacdCB5eF | |||
target_vm_ip | String | 目标机ip |
一级副本 - 操作
SDK方法名:operateFirstReplica;
URL
/replica/first/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
operate | String | start_vm:开机; stop_vm:关机; | |||
rule_uuids | Array | 规则uuid |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功 |
一级副本 - 删除
SDK方法名:deleteFirstReplica;
URL
/replica/first
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuids | String | ||||
group_uuids | String | ||||
delete_tgtvm | Number | 是否删除目标虚机,0,1 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功 |
--- 二级副本(复用整机备份) ---
URL
/------- 二级副本 -------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
二级副本 - 新建
参照 整机副本规则;
SDK类名:/replica/Second;
SDK方法名:createSecondReplica;
URL
/replica/second
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_backup | Object | ||||
fsp_name | String | 虚机名称 | |||
fsp_type | Number | 固定传22 | 22 | ||
wk_uuid | String | 工作机uuid | |||
bk_uuid | String | 灾备代理节点 | |||
wk_data_type | Number | 固定传0(同整机副本) | 0 | ||
bk_data_type | Number | 固定传21(同整机副本) | 21 | ||
resource_settings | Object | 虚机设置 | |||
tgt_uuid | String | 目标平台uuid | |||
new_dc | String | 数据中心 | |||
new_dc_mor | String | 数据中心标识 | |||
new_host | String | 主机 | |||
new_ds | String | 存储 | |||
vm_list | Array | 虚机列表 | |||
vm_name | String | 工作机 | |||
new_vm_name | String | 目标机名称 | |||
new_vm_hostname | String | 目标机主机名 | |||
custom_config | Number | 自定义设置: 是否勾选自定义设置: 0:否; 1:是; | 1 | ||
cpu | String | cpu数量 | |||
core_per_sock | String | 核心数 | |||
mem_mb | String | 内存 | |||
dynamic_mem | String | 0 | |||
disk_list | Array | ||||
boot_index | String | ||||
file_name | String | ||||
new_ds | String | ||||
size | String | ||||
is_ignored | String | ||||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
disk_provision_type | Number | 1 | |||
networks | Array | ||||
source_network_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | (华云平台参数) 网关 | |||
is_defroute | Boolean | (华云平台参数) 是否默认网关 | false | ||
create_vm_type | Number | 创建虚机策略: 0:指定节点; 1:系统调配; | |||
timeout | Number | 0 | |||
data_ip_uuid | String | '' | |||
wk_path | Array | [] | |||
bk_path | Array | [] | |||
auto_register | Number | 0 | |||
node_name | String | '' | |||
node_lic_list | Array | [] |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功 |
二级副本 - 获取列表
SDK方法名:listSecondReplica;
URL
/replica/second
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | ||||
limit | Number |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info_list | Array | ||||
fsp_name | String | 虚机名称 | Donna Smith | ||
fsp_uuid | String | 二级副本uuid | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | ||
tgt_name | String | 目标平台名称 | DcDd4A7d-2Ae3-bFd7-d346-14F0A9Fad77C | ||
username | String | 所有者 | Daniel Smith | ||
wk_uuid | String | 工作机uuid | |||
wk_node_name | String | 工作机名称 | |||
can_del | Number | 1 | |||
can_up | Number | 1 | |||
can_op | Number | 1 | |||
tgt_config_addr | String | 目标平台管理地址 | |||
hostname | String | 主机 | |||
datastore | String | 存储 | |||
total | Number | 1 |
二级副本 - 获取详情
SDK方法名:describeSecondReplica;
URL
/replica/second/:uuid([A-F0-9-]+)
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
fsp_backup | Object | ||||
fsp_type | Number | 22 | |||
wk_uuid | String | ||||
bk_uuid | String | ||||
data_ip_uuid | String | '' | |||
timeout | Number | 0 | |||
wk_path | Array | ||||
bk_path | Array | ||||
resource_settings | Object | ||||
tgt_uuid | String | ||||
new_dc | String | ||||
new_host | String | ||||
new_ds | String | ||||
new_dc_mor | String | ||||
vm_list | Array | ||||
disk_list | Array | ||||
boot_index | String | ||||
file_name | String | ||||
new_ds | String | ||||
size | String | ||||
is_ignored | String | ||||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
disk_provision_type | Number | 1 | |||
vm_name | String | ||||
new_vm_name | String | ||||
custom_config | Number | 1 | |||
cpu | String | ||||
core_per_sock | String | ||||
mem_mb | String | ||||
dynamic_mem | String | 0 | |||
networks | Array | ||||
source_network_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | (华云平台参数) 网关 | |||
is_defroute | Boolean | (华云平台参数) 是否默认网关 | false | ||
fsp_name | String | ||||
bk_data_type | Number | 21 | |||
wk_data_type | Number | 0 | |||
auto_register | Number | 0 | |||
node_name | String | '' | |||
node_lic_list | Array | ||||
total | Number | 1 |
二级副本 - 修改
UUID为group_uuid
SDK方法名:modifySecondReplica;
URL
/replica/second
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_backup | Object | ||||
fsp_type | Number | 22 | |||
wk_uuid | String | ||||
bk_uuid | String | ||||
data_ip_uuid | String | '' | |||
timeout | Number | 0 | |||
wk_path | Array | ||||
bk_path | Array | ||||
resource_settings | Object | ||||
tgt_uuid | String | ||||
new_dc | String | ||||
new_host | String | ||||
new_ds | String | ||||
new_dc_mor | String | ||||
vm_list | Array | ||||
disk_list | Array | ||||
boot_index | String | ||||
file_name | String | ||||
new_ds | String | ||||
size | String | ||||
is_ignored | String | ||||
disk_name | String | ||||
disk_path | String | ||||
id | String | ||||
disk_provision_type | Number | 1 | |||
vm_name | String | ||||
new_vm_name | String | ||||
custom_config | Number | 1 | |||
cpu | String | ||||
core_per_sock | String | ||||
mem_mb | String | ||||
dynamic_mem | String | 0 | |||
networks | Array | ||||
source_network_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | (华云平台参数) 网关 | |||
is_defroute | Boolean | (华云平台参数) 是否默认网关 | false | ||
fsp_name | String | ||||
bk_data_type | Number | 21 | |||
wk_data_type | Number | 0 | |||
auto_register | Number | 0 | |||
node_name | String | '' | |||
node_lic_list | Array |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 |
二级副本 - 操作
SDK方法名:operateSecondReplica;
URL
/replica/second/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
operate | String | start:启动; stop:停止; start_vm:开机; stop_vm:关机; | |||
fsp_uuids | Array |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 11110001 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test2 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test1 |
二级副本 - 删除
SDK方法名:deleteSecondReplica;
URL
/replica/second
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_uuids | Array | ||||
del_policy | Number | 删除策略: 0:不开启; 1:开启; | |||
force | Number | 是否强制删除: 0:否; 1:是; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test1 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
fsp_uuid | String | @guid | |||
fsp_name | String | test2 |
二级副本 - 获取状态
SDK方法名:listSecondReplicaStatus;
URL
/replica/second/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
fsp_uuids | Array | ||||
force_refresh | Number | 强制刷新: 0:否; 1:是; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
status | Array | ||||
status | String | 同步状态 | STOP | ||
vm_status | String | 虚机状态 | @pick(MIRROR, START) | ||
fsp_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
f_total | String | 0 | |||
progress | String | 0 | |||
target_vm_ip | String | 目标虚机ip | |||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 |
------ 虚机克隆 ------
URL
/dash/vm_clone
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
虚机克隆规则 - 新建
SDK类名:/vmClone/VmCloneRule;
SDK方法名:createVmCloneRule;
URL
/vm_clone/rule
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_name | String | 任务名称 | |||
wk_uuid | String | 工作机uuid | |||
bk_uuid | String | 灾备机uuid | |||
wk_path | Array | 工作路径 | |||
bk_path | Array | 灾备路径 | |||
prefix | String | 虚机名称前缀 | |||
vm_cnt | Number | 虚机数量 | |||
vp_uuid | String | 目标平台uuid | |||
new_dc | String | 数据中心 | |||
new_dc_mor | String | 数据中心唯一标识 | |||
new_host | String | 主机 | |||
new_ds | String | 存储 | |||
create_vm_type | Number | 克隆目标主机选项(安超云): 0:指定节点 1:系统调配 | |||
vm_list | Array | 虚机列表 | |||
vm_name | String | 虚机名称 | |||
vm_hostname | String | 虚机主机名 | |||
cpu | Number | 处理器数量 | |||
core_per_sock | Number | 处理器核心数 | |||
mem_mb | Number | 内存 | |||
dns | String | VMware | |||
networks | Array | ||||
source_network_name | String | 源端网卡 | |||
mac_address | String | 源端MAC地址(华云平台传'') | |||
keep_mac | String | 保留MAC(华云平台传'') | |||
network_id | String | 目标平台网卡 | |||
network_name | String | 目标平台网卡名称 | |||
subnet_name | String | 子网名称(华云平台参数) | |||
auto_ip | Boolean | 自动ip开关: true:开; false:关; (华云平台参数) | |||
ip | String | ip地址(华云平台参数) | |||
security_group_name | String | 安全组名称(华云平台参数) | |||
gateway | String | 目标网关 | |||
auto_start | Number | 规则自启动: 0:关; 1:开; | |||
bkup_policy | Number | 备份策略: 0:预约执行; 2:立即执行; 3:手动执行; | |||
bkup_one_time | Number | 预约执行时间,unix时间戳 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String |
虚机克隆规则 - 获取列表
SDK方法名:listVmCloneRule;
URL
/vm_clone/rule
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | ||||
limit | Number | ||||
search_field | String | 搜索字段: rule_name:任务名称; vp_name:平台名称; wk_node_name:工作机名称; | |||
search_value | String | 搜索值 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info_list | Array | 2-5 | |||
rule_uuid | String | 规则uuid | 224fB2fc-FFC5-Dbc9-5883-d53CEB8Be389 | ||
rule_name | String | 规则名称 | rule-@name | ||
vm_cnt | Number | 虚机数量 | 2-5 | ||
wk_uuid | String | 工作机uuid | @uuid | ||
wk_node_name | String | 工作机数量 | wk_@first | ||
vp_uuid | String | 目标平台uuid | @uuid | ||
vp_name | String | 目标平台名称 | vp-@first | ||
user_uuid | String | 用户uuid | @uuid | ||
username | String | 用户名称 | user-@first | ||
total | Number | 1 |
虚机克隆规则 - 获取单个详情
SDK方法名:describeVmCloneRule;
URL
/vm_clone/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 | ||||
vm_clone_rule | Object | ||||
rule_name | String | ||||
wk_uuid | String | ||||
bk_uuid | String | ||||
wk_path | Array | ||||
bk_path | Array | ||||
auto_start | Number | 1 | |||
prefix | String | ||||
vm_cnt | Number | 1 | |||
vp_uuid | String | ||||
new_dc | String | ||||
new_dc_mor | String | ||||
new_host | String | ||||
new_ds | String | ||||
create_vm_type | Number | 1 | |||
vm_list | Array | ||||
vm_name | String | ||||
cpu | Number | 1 | |||
core_per_sock | Number | 1 | |||
mem_mb | Number | 1 | |||
dns | String | ||||
networks | Array | ||||
source_network_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
subnet_name | String | ||||
auto_ip | String | ||||
ip | String | ||||
security_group_name | String | ||||
gateway | String |
虚机克隆规则 - 删除
SDK方法名:deleteVmCloneRule;
URL
/vm_clone/rule
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuids | Number | 规则uuid数组 | |||
force | Number | 强制删除 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
rule_uuid | String | 规则uuid | @guid | ||
rule_name | String | 规则名称 | test1 | ||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
rule_uuid | String | @guid | |||
rule_name | String | test2 |
虚机克隆规则 - 操作
SDK方法名:operateVmCloneRule;
URL
/vm_clone/rule/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rules_uuid | Number | 规则uuid数组 | |||
operate | String | 操作: start:开始; stop:停止; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 11110001 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
rule_uuid | String | 规则uuid | @guid | ||
rule_name | String | 规则名称 | test2 | ||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
rule_uuid | String | @guid | |||
rule_name | String | test1 |
虚机克隆规则 - 获取状态
SDK方法名:listVmCloneRuleStatus;
URL
/vm_clone/rule/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuids | Number | 规则uuid数组 | |||
force_refresh | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
status | Array | ||||
rule_uuid | String | 规则uuid | 224fB2fc-FFC5-Dbc9-5883-d53CEB8Be389 | ||
status | String | 状态字段: CLONING:克隆中 | STOP | ||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 |
虚机克隆虚机 - 获取列表
SDK类名:/vmClone/VmCloneVm;
SDK方法名:listVmCloneVm;
URL
/vm_clone/vm
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | ||||
limit | Number | ||||
where_args[status] | String | 虚机状态过滤: | |||
search_field | String | 搜索字段: sys_name:应用系统名称 vp_name:虚拟平台名称; vm_name:虚机名称; | |||
search_value | String | 搜索值 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info_list | Array | 2-10 | |||
uuid | String | 虚机记录uuid | @pick(['F0Bd1A0B-503F-D174-d298-eeF39aBAcfAe','fFbfcBDC-fef1-38d8-0848-F5ECb2D34627']) | ||
vm_name | String | 虚机名称 | vm-@first | ||
rule_uuid | String | 关联的规则uuid | @uuid | ||
rule_name | String | 关联的规则名称 | rule-@first | ||
sys_name | String | 应用系统名称 | sys-@first | ||
user_uuid | String | 用户uuid | @uuid | ||
username | String | 用户名 | user-@first | ||
vp_uuid | String | 目标平台uuid | @uuid | ||
vp_name | String | 目标平台名称 | vp-@first | ||
vp_config_addr | String | 目标平台管理地址 | |||
wk_uuid | String | 工作机uuid | |||
wk_node_name | String | 工作机名称 | |||
wk_config_addr | String | 工作机管理地址 | |||
wk_ip | String | 工作机数据地址 | |||
bk_uuid | String | 灾备代理节点uuid | |||
bk_node_name | String | 灾备代理节点名称 | |||
bk_config_addr | String | 灾备代理节点管理地址 | |||
bk_ip | String | 灾备代理节点数据地址 | |||
total | Number | 1 |
虚机克隆虚机 - 修改虚机配置
SDK方法名:modifyVmConfig;
URL
/vm_clone/vm/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
vm_name | String | 虚机名称 | |||
vm_hostname | String | 主机名称 | |||
cpu | Number | 处理器数量 | |||
core_per_sock | Number | 处理器核心数 | |||
mem_mb | Number | 内存 | |||
dns | String | dns(VMware) | |||
networks | Array | ||||
source_network_name | String | 源端网卡 | |||
mac_address | String | 源端MAC地址(华云平台传'') | |||
keep_mac | String | 保留MAC(华云平台传'') | |||
network_id | String | 目标平台网卡 | |||
network_name | String | 目标平台网卡名称 | |||
subnet_name | String | 子网名称(华云平台参数) | |||
auto_ip | Boolean | 自动ip开关: true:开; false:关; (华云平台参数) | |||
ip | String | ip地址(华云平台参数) | |||
security_group_name | String | 安全组名称(华云平台参数) | |||
gateway | String | 目标网关 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 |
虚机克隆虚机 - 删除
SDK方法名:deleteVmCloneVm;
URL
/vm_clone/vm
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
uuids | Array | 虚机记录uuid数组 | |||
force | Number | 强制删除 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
uuid | String | @guid | |||
vm_name | String | test1 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
uuid | String | @guid | |||
vm_name | String | test2 |
虚机克隆虚机 - 操作
SDK方法名:operateVmCloneVm;
URL
/vm_clone/vm/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
uuids | String | 虚机记录uuid数组 | |||
operate | String | 操作: start_vm:开机; stop_vm:关机; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
code | Number | 11110001 | |||
message | String | ||||
fail_list | Array | ||||
code | Number | 11110001 | |||
message | String | [-1] 离线 | |||
uuid | String | @guid | |||
vm_name | String | test2 | |||
success_list | Array | ||||
code | Number | 11110001 | |||
message | String | [0] success | |||
uuid | String | @guid | |||
vm_name | String | test1 |
虚机克隆虚机 - 获取状态
SDK方法名:listVmCloneVmStatus;
URL
/vm_clone/vm/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
force_refresh | Number | 强制刷新 | |||
uuids | Array | ['F0Bd1A0B-503F-D174-d298-eeF39aBAcfAe', 'fFbfcBDC-fef1-38d8-0848-F5ECb2D34627'] |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
status | Object | ||||
uuid | String | '' | |||
status | String | ONLINE:在线; OFFLINE:离线; PREPARE:准备中; UNKNOWN:未知; MODIFYING:; | STOP | ||
last_result | Object | 上次修改结果 | |||
result | Number | 结果: 0:成功; 1:失败; | |||
time | String | 修改时间 | |||
ip | String | 虚机ip | |||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 |
虚机克隆虚机 - 获取详情
SDK方法名:describeVmCloneVm;
URL
/vm_clone/vm/:uuid([A-F0-9-]+)
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
msg | String | ||||
ret | Number | 200 | |||
data | Object | ||||
count | Number | 0 | |||
message | String | ||||
code | Number | 0 | |||
vm_clone_vm | Object | ||||
rule_uuid | String | 整机克隆任务的uuid | |||
rule_name | String | ||||
new_dc | String | ||||
new_dc_mor | String | ||||
new_host | String | ||||
new_ds | String | ||||
vp_uuid | String | 虚拟平台uuid | |||
vp_type | String | ||||
uuid | String | 当前虚机自己的uuid | |||
vm_name | String | ||||
vm_uuid | String | 虚机uuid,可能为空 | |||
cpu | Number | 1 | |||
core_per_sock | Number | 1 | |||
mem_mb | Number | 1 | |||
dns | String | ||||
networks | Array | ||||
source_network_name | String | ||||
mac_address | String | ||||
keep_mac | String | ||||
network_id | String | ||||
network_name | String | ||||
subnet_name | String | ||||
auto_ip | Boolean | false | |||
ip | String | ||||
security_group_name | String | ||||
gateway | String | ||||
user_uuid | String | ||||
create_time | Number |
--- 历史版本 ---
SDK类名:/ruleVersion/RuleVersion;
URL
/------- 历史版本 -------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
历史版本 - 列表
SDK方法名:listRuleVersion;
URL
/rule_version
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | ||||
limit | Number | ||||
where_args[uuid] | String | 规则uuid | |||
where_args[type] | String | 规则类型: rep:文件备份; fsp:整机备份; vp:虚机备份; move:迁移; ha:高可用; script:高可用脚本; | |||
like_args[sys_name] | String | 应用系统名称 | |||
like_args[protect_name] | String | 保护对象名称 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
message | String | [0] 操作成功 | |||
info_list | Array | ||||
id | String | 自增主键 | @increment | ||
uuid | String | 规则uuid | |||
name | String | 规则名称 | |||
type | String | 规则类型: rep:文件备份; fsp:整机备份; vp:虚机备份; move:迁移; ha:高可用; | |||
major | Number | 是否主版本: 0:否; 1:是; | 1 | ||
version | String | 版本 | |||
sys_name | String | 应用系统名称 | |||
protect_name | String | 保护对象名称 | |||
username | String | 操作用户名 | |||
user_uuid | String | 操作用户uuid | |||
total | Number | 1 | |||
code | Number | 0 |
历史版本 - 查看具体信息
SDK方法名:describeRuleVersionInfo;
URL
/rule_version/info
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
id | Number | 主键id |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
message | String | ||||
info | Object | 规则配置信息 | |||
code | Number | 0 |
历史版本 - 操作
SDK方法名:operateRuleVersion;
URL
/rule_version/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ids | Array | 规则id(当前不支持批量操作) | |||
operate | String | 操作类型: set_main:设置为主版本; |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success | |||
file_name | String | 脚本类型 - 下载操作,返回的文件名 |
------- 回收站 -------
SDK类名:/recycleBin/RecycleBin;
URL
/------- 回收站 -------
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
回收站 - 获取列表
SDK方法名:listRecycleBin;
URL
/recycle_bin
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
page | Number | 页数 | |||
limit | Number | 条数 | |||
where_args[type] | String | 规则类型,同历史版本: rep:文件备份; fsp:整机备份; vp:虚机备份; move:迁移; ha:高可用; | |||
search_field | String | name,名称模糊查询 | |||
search_value | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
message | String | [0] 操作成功 | |||
info_list | Array | ||||
id | String | @increment | |||
uuid | String | 规则UUID | |||
name | String | 规则名称 | |||
type | String | 规则类型 | |||
user_uuid | String | 操作用户UUID | |||
username | String | 操作用户名 | |||
total | Number | 1 | |||
code | Number | 0 |
回收站 - 获取配置
SDK方法名:describeRecycleBin;
URL
/recycle_bin/:uuid([A-F0-9-]+)/info
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | ||||
info | Object | 规则数据库配置信息,对应不同类型规则 |