i2UP接口文档

# 一体机虚机

一体机虚机

# 虚机 - 获取模板列表

# URL

//box_vm/template

# Method

GET

# Request

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

# Response

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

# 虚机 - 新建

# URL

//box_vm

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
vm_name String 是 win2008 虚机名称
bk_uuid String 是 xxxxx 主机uuid
template String 是 win2008r2 模板名称
disk Array 是 2
  name String 是 D 磁盘名称
  size String 是 1 磁盘容量（单位G）
hardware Object 是
  cpu String 是 2 CPU个数
  mem String 是 4 内存容量（单位G）
network Object 是
  ip String 是 192.168.20.8 虚机IP地址
  gateway String 是 192.168.1.10 网关
  netmask String 是 255.255.192.0 掩码

# Response

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

# 虚机 - 列表

# URL

//box_vm

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 否 1
page Number 否 1
search_value String 否
search_field String 否

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  total Number 否 0
  info_list Array 否
    vm_uuid String 否 win2008 虚机UUID
    vm_name String 否 win2008
    bk_uuid String 否 xxxxx
    wk_uuid String 否 xxxxx 由虚机创建的节点UUID
    template String 否 win2008r2
    network Object 否
      ip String 否 192.168.20.8
      gateway String 否 192.168.1.10
      netmask String 否 255.255.192.0
    user_uuid String 否
    username String 否
    create_time Number 否 1
    random_str String 否

# 虚机 - 单个

URL参数为：虚机UUID

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  box_vm Object 否
    vm_uuid String 否 win2008
    vm_name String 否 win2008
    bk_uuid String 否 xxxxx
    wk_uuid String 否 xxxxx
    template String 否 win2008r2
    disk Array 否 2
      name String 否 D
      size String 否 1
    hardware Object 否
      cpu String 否 2
      mem String 否 4
    network Object 否
      ip String 否 192.168.20.8
      gateway String 否 192.168.1.10
      netmask String 否 255.255.192.0
    user_uuid String 否
    username String 否
    create_time Number 否 1
    random_str String 否

# 虚机 - 删除

# URL

//box_vm

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
vm_uuids Array 否 虚机UUID

# Response

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

# 虚机 - 状态

# URL

//box_vm/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
vm_uuids Array 否 虚机UUID

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
  status Array 否
    vm_uuid String 否 9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
    status String 否 'RUN'：运行；

'PAUSED'：暂停； 'WORKING'：工作； 'SHUT_OFF'：关闭； 'SHUT_DOWN'：关闭中； 'BLOCKED'：被阻止； 'NO_STATE'：无状态； 'CRASHED'：已崩溃； 'SUSPENDED'：被挂起； |

# 虚机 - 操作

# URL

//box_vm/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String 否 register 注册：register
vm_uuids Array 否 虚机UUID

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
Last Updated: 12/3/2019, 3:27:53 PM