i2UP接口文档

# VP演练

# ----- 演练配置 -----

示例接口描述

# URL

//dash5

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
foo String 否 @ctitle 请求属性示例

# Response

名称 类型 必选 初始值 简介 Mock规则
string String 否 ★ 字符串属性示例 1-10
number Number 否 1 数字属性示例 1-100
boolean Boolean 否 true 布尔属性示例 1-2
regexp RegExp 否 /[a-z][A-Z][0-9]/ 正则属性示例
function Function 否 () => Math.random() 函数属性示例
array Array 否 数组属性示例 1-10
  foo Number 否 1 数组元素示例 +1
  bar String 否 ★ 数组元素示例 1-10
items Array 否 [1, true, 'hello', /\w{10}/] 自定义数组元素示例
object Object 否 对象属性示例
  foo Number 否 1 对象属性示例 +1
  bar String 否 ★ 对象属性示例 1-10
placeholder String 否 @title 占位符示例

# 添加演练配置（废弃）

# URL

//vp/platform/drill

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
vp_uuid String 是 虚拟平台ID
config Object 是
  proxy_name String 是 代理网关名称
  proxy_ip String 是 代理网关ip
  proxy_mask String 是 代理网关子网掩码
  proxy_gw String 是 代理网关的网关
  new_hostname String 是 主机名
  new_ds String 是 数据存储
  new_dc String 是 数据中心
  new_dc_mor String 是 数据中心托管对象值
  network_id String 是 代理网关id
  network_name String 是 代理网关名称

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功

# 删除演练配置(废弃)

# URL

//vp/platform/drill

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
vp_uuid String 否

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功

# 获取演练配置(废弃)

# URL

//vp/drill_plat/:uuid([A-F0-9-]+)

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  vp_drill_platform Object 否
    vp_uuid String 否 1663DD96-C9BE-B49E-6044-3AB3120F4B74
    vp_name String 否 88.107
    vp_type Number 否 0
    vp_addr String 否 192.168.88.107
    config_addr String 否 192.168.72.75
    config_port String 否 58083
    os_usr String 否 root
    os_pwd String 否 12345678
    comment String 否
    create_time String 否 1533871285
    random_str String 否 AB790B28-62D6-7236-612F-65D73C80036F
    user_uuid String 否 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    username String 否 admin
    lab_uuid String 否
    config Object 否
      network_id String 否
      network_name String 否
      new_dc String 否
      new_dc_mor String 否
      new_ds String 否
      new_hostname String 否
      proxy_name String 否
      proxy_ip String 否
      proxy_mask String 否
      proxy_gw String 否

# 演练平台 - 获取列表（废弃）

# URL

//vp/drill_plat

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  total Number 否 3
  info_list Array 否
    vp_uuid String 否 1663DD96-C9BE-B49E-6044-3AB3120F4B74
    vp_name String 否 88.107
    vp_type Number 否 0
    vp_addr String 否 192.168.88.107
    user_uuid String 否 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    username String 否 admin
    lab_name String 否
    lab_uuid String 否
    config Object 否
      proxy_name String 否
      proxy_ip String 否
      proxy_mask String 否
      proxy_gw String 否
      npsvr_vip String 否
      npsvr_vmask String 否
      npsvr_vgw String 否
      product_ip String 否
      product_mask String 否
      product_gw String 否
      isolate_ip String 否
      isolate_mask String 否
      isolate_gw String 否
      new_hostname String 否
      new_ds String 否
      new_dc String 否

# 演练平台 - 状态（废弃）

# URL

//vp/drill_plat/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
lab_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] lab_uuid 数组

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  status Array 否
    lab_uuid String 否 4Ce6Bc6d-B84F-AfBC-39cA-F77fe5dcA1Be
    status String 否 DEPLOYED：部署完成；STALE：失效；DEPLOYING：部署中；

# ----- 演练规则 -----

# URL

//dash6

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则

# 演练规则 - 新建

# URL

//vp/drill

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
rule_name String 是 规则名称（备份规则任务和复制规则任务的名称）
rule_type Number 是 0 对应规则类型：备份：0；复制：1；
vp_uuid String 是 演练平台对应 虚拟平台的ID
datacenter String 是 数据中心
new_dc_mor String 否 目标平台数据中心托管对象值
hostname String 是 主机名称
datastore String 否 数据存储，没有传空串
auto Number 否 0 自动演练：自动：1，手动：0；
vm_list Array 否
  vm_name String 否 虚机名称
  vm_ref String 否 99 虚机ID
  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_path String 否 从备份规则拿 bk_path，前端拼接，拼接逻辑与还原时调 bak_ver_info 的逻辑相同
  original_rule_uuid String 否 原始规则uuid
  os_type Number 否 （新加）虚拟机操作系统： 0：linux； 1：windows
  ver_sig String 否 信息ID
  time String 否 选择的时间点，RPC不用
  mac String 否 mac地址
  vm_cfg Object 否 此处略，同虚机恢复的同名字段内容一样
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规则
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

# URL

//vp/drill/group/:uuid([A-F0-9-]+)

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 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 否

# 演练规则 - 列表

获取规则列表；获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

# URL

//vp/drill

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
page Number 否 1 可选
limit Number 否 10 可选

# Response

名称 类型 必选 初始值 简介 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 否
  total Number 否 1

# 演练规则 - 状态

获取规则的状态

# URL

//vp/drill/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
rule_uuids Array 否 ["11111111-1111-1111-1111-111111111111"]

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否
data Object 否
  count String 否 1
  message String 否
  code Number 否 0
  status Array 否 2
    status String 否 VP_START SUCCESS FAILED
    progress Number 否 71
    rule_uuid String 否 Ac2F4EFC-14FE-b2Ab-7988-7AD4f44979E3
ret Number 否 200

# 演练规则 - 操作

# URL

//vp/drill/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String 否 "start", "stop", "set_status"：启动、停止、设置状态（仅运行状态可以）
rule_uuids Array 否 [C6335F62-2565-1957-4BB9-587F2FF46B00] 规则uuid列表
group_uuids Array 否 组操作，有这个就先用这个，没有就用规则uuid
status String 否 仅设置状态传：状态码，0成功，-1失败
msg String 否 仅设置状态传：用户上传的信息

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功

# 演练规则 - 删除

删除规则

# URL

//vp/drill

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
rule_uuids Array 否 ["11111111-1111-1111-1111-111111111111"]
group_uuids Array 否 组操作，有这个就先用这个，没有就用规则uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
Last Updated: 5/13/2020, 3:56:32 AM