cloudpods/docs/schemas/host.yaml

Host:
  type: object
  description: 宿主机
  properties:
    id:
      type: string
      example: ea27c0ce-5870-49f3-8d57-f53e63f40361
      description: 宿主机uuid
      readOnly: true
    name:
      type: string
      description: 宿主机名称
      example: host-r4hilqks
      readOnly: true
    billing_type:
      type: string
      description: 计费类型
      example: postpaid
      readOnly: true
    zone:
      type: string 
      example: 腾讯云 广州三区
      description: 可用区名称
    zone_id:
      type: string 
      example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc
      description: 可用区ID
    region:
      type: string 
      example: 腾讯云 华南地区(广州)
      description: 区域名称
    region_id:
      type: string 
      example: 13947bd8-569e-4094-8b03-4339c2a8e45b
      description: 区域ID
    update_version:
      type: integer 
      example: 2
      description: 资源被更新的次数
    updated_at:
      type: string 
      example: 2019-05-30T06:36:39.000000Z
      description: 资源最近一次更新时间
    provider:
      type: string 
      example: Qcloud
      description: 纳管云平台
    brand:
      type: string
      example: DStack
      description: 虚拟化品牌
    created_at:
      type: string
      example: 2019-05-30T02:25:38.000000Z
      description: 资源创建时间
    access_ip:
      type: string
      example: 10.168.222.234
      description: 宿主机Master网卡ip
    access_mac:
      type: string
      example: 00:22:d5:9e:28:d2
      description: 宿主机master网卡mac
    can_delete:
      type: boolean
      example: false
      description: 宿主机是否能删除
    can_update:
      type: boolean
      example: true
      description: 宿主机是否能更新
    cloud_env:
      type: string
      example: onpremise
      description: 宿主机所属的云类型
    cpu_cache:
      type: integer
      example: 16384
      description: 宿主机cpu缓存大小
    cpu_cmtbound:
      type: float
      example: 4.000000
      description: 宿主机cpu超售比
    cpu_commit:
      type: integer
      example: 1
      description: 宿主机已分配cpu个数
    cpu_commit_rate:
      type: float
      example: 0.125000
      description: 宿主机已分配cpu比率
    cpu_count:
      type: integer
      example: 8
      description: 宿主机cpu个数
    cpu_desc:
      type: string
      example: Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
      description: 宿主机cpu型号信息
    cpu_mhz:
      type: integer
      example: 2793
      description: 宿主机cpu频率，近似值
    cpu_microcode:
      type: string
      example: 0x1
      description: 宿主机cpu微码
    cpu_reserved:
      type: integer
      example: 0
      description: 宿主机预留cpu个数
    description:
      type: string
      example: test host
      description: 宿主机备注信息
    enabled:
      type: boolean
      example: false
      description: 宿主机是否启用
    guests:
      type: integer
      example: 3
      description: 宿主机上虚拟机个数
    host_status:
      type: string
      example: offline
      description: 宿主机状态
    host_type:
      type: string
      example: hypervisor
      description: 宿主机类型
    is_baremetal:
      type: boolean
      example: false
      description: 是否是物理机
    is_emulated:
      type: boolean
      example: false
      description: 是否是虚拟资源
    is_import:
      type: boolean
      example: false
      description: 是否是托管的宿主机
    is_maintenance:
      type: boolean
      example: false
      description: 物理机是否在维护状态
    is_prepaid_recycle:
      type: boolean
      example: false
      description: 宿主机在预付费资源池中
    manager_uri:
      type: string
      example: http://10.168.222.234:8885
      description: 宿主机服务地址
    mem_cmtbound:
      type: float
      example: 1.000000
      description: 宿主机内存超售比
    mem_commit:
      type: integer
      example: 10240
      description: 已分配内存/MB
    mem_commit_rate:
      type: float
      example: 0.125000
      description: 已分配内存比率
    mem_reserved:
      type: integer
      example: 1024
      description: 预留内存数量
    meme_size:
      type: integer
      example: 8192
      description: 宿主机内存大小
    nic_count:
      type: integer
      example: 1
      description: 宿主机上网卡数量
    nic_info:
      type: string
      description: 网卡信息
    node_count:
      type: integer
      example: 1
      description: 宿主机上cpu node数量
    nonsystem_guests:
      type: integer
      example: 4
      description: 非系统资源的虚拟机数量
    rack:
      type: string
      example: rack0
      description: 机架信息
    resource_type:
      type: string
      example: shared
      enum: [shared,prepaid,dedicated]
      description: 资源类型
    slots:
      type: string
      example: slot0
      description: 内存插槽
    sn:
      type: string
      example: 6CR338WPFP
      description: 机器序列号
    status:
      type: string
      example: running
      description: 物理机状态
    storage:
      type: integer
      example: 201456
      description: 宿主机存储大小
    spec:
      type: string
      example: {"cpu":8,"mem":8192,"nic_count":0}
      description: 宿主机简略信息
    storage_commit_rate:
      type: float
      example: 0.760000
      description: 宿主机存储分配比率
    storage_driver:
      type: string
      example: Linux
      description: 宿主机存储驱动
    storage_free:
      type: integer
      example: 47856
      description: 宿主机存储剩余大小
    storage_size:
      type: integer
      example: 201456
      description: 宿主机存储大小
    storage_type:
      type: string
      example: rotate
      description: 宿主机存储类型，机械盘/ssd
    storage_used:
      type: integer
      example: 153600
      description: 宿主机已使用存储大小
    storage_virtual:
      type: integer
      example: 201456
      description: 宿主机存储大小(虚拟大小，宿主机存储可超售)
    storage_waste:
      type: integer
      example: 201456
      description: 宿主机浪费存储大小
    sys_info:
      type: string
      description: 宿主机上一些元信息

HostResponse:
  type: object
  properties:
    host:
      type: object
      $ref: '#/Host'

HostListResponse:
  type: object
  properties:
    limit: 
      type: integer
      example: 20
    hosts:
      type: array
      items:
        $ref: '#/Host'
    total:
      type: integer
      example: 124

HostUpdate:
  type: object
  properties:
    name:
      type: string
      example: new-host-name
    desc:
      type: string
      example: new-host-desc
    cpu_commit_bound:
      type: float
      example: 4.0
      description: 宿主机cpu超售比
    memory_commit_bound:
      type: float
      example: 1.1
      description: 宿主机内存超售比
    memory_reserved:
      type: integer
      example: 10240
      description: 宿主机预留内存大小
    cpu_reserved:
      type: integer
      example: 10
      description: 宿主机预留cpu大小
    host_type:
      type: string
      enum: [hypervisor,kubelet,esxi,baremetal]
      description: 宿主机类型
    access_ip:
      type: string
      description: 宿主机access ip

HostCreate:
  type: object
  properties:
    name:
      type: string
      example: new-host-name
      required: true
    mac:
      type: string
      description: 物理机的mac地址
      required: true
    rack:
      type: string
      description: rack number of baremtal
    slots:
      type: string
      description: slots number of baremetal
    ipmi_user:
      type: string
      description: ipmi 用户名
    ipmi_passwd:
      type: string
      description: ipmi密码
    ipmi_addr:
      type: string
      description: ipmi地址

HostIpmi:
  type: object
  properties:
    ip_addr:
      type: string
      description: ipmi地址
    lan_channel:
      type: integer
      description: ipmi信道
    password:
      type: string
      description: ipmi登录密码
    username:
      type: string
      description: ipmi用户名

HostConvertHypervisor:
  type: object
  properties:
    name:
      type: string
      required: true
      description: 转换的宿主机的名字
    host_type:
      type: string
      required: true
      enum: [hypervisor,esxi,kubelet,hyperv]
      description: 转换后的宿主机类型
    image:
      type: string
      description: 转换成宿主机所用的镜像
    raid:
      type: string
      enum: [raid0,raid1,raid10,raid5,none]
      description: 物理机磁盘raid类型
    baremetal_disk_config:
      type: array
      description: 物理机磁盘raid配置
      $ref: '#/BaremetalDiskConfig'
    disk:
      type: array
      description: 宿主机磁盘配置信息
      $ref: "../schemas/instance.yaml#/InstanceDiskInfo"
    net:
      type: array
      description: 宿主机网卡配置信息
      $ref: "#/Network"

Network:
  type: object
  properties:
    index:
      type: integer
      example: 0
      description: 网络索引编号
    network:
      type: string
      example: dab5b874-755a-4223-89a5-4acf36305756
      description: 网络名称或ID
    wire:
      type: string
      example: a53adc31-7601-4ddf-8874-93639f5626db
      description: 二层网络名称或ID
    exit: 
      type: boolean
      default: false
      example: true
      description: 是否是外网ip
    address:
      type: string
      example: 192.168.222.203
      description: 分配的IP地址

BaremetalDiskConfig:
  type: object
  properties:
    type:
      type: string
      enum: [ssd, rotate]
      description: 磁盘介质类型
    conf:
      type: string
      enum: [raid0,raid1,raid10,raid5,none]
      description: raid 配置信息
    count:
      type: integer
      description: 使用几块盘做raid(连续的)
    range:
      type: array
      items:
        $ref: '#/RaidRange'
      description: 使用指定的磁盘做raid
    adapter:
      type: integer
      example: 2
      description: raid卡上的adapter
    driver:
      type: string
      example: MegaRaid
      description: raid卡类型

RaidRange:
  type: integer
  description: 磁盘号

HostAddNetif:
  type: object
  properties:
    wire:
      type: string
      required: true
      description: 物理机所属的wire Id或Name
    mac:
      type: string
      required: true
      description: 添加的网卡的mac地址
    type:
      type: string
      enum: [admin, ipmi]
      description: 网卡类型
    ip_address:
      type: string
      description: 网卡的ip地址

HostRemoveNetif:
  type: object
  properties:
    mac:
      type: string
      required: true
      description: 要移除网卡的mac地址

HostSpec:
  type: object
  properties:
    cpu:
      type: integer
      description: 宿主机cpu数量
    disk:
      type: string
      description: 宿主机磁盘配置信息
    driver:
      type: string
      description: 宿主机存储驱动
    nic_count:
      type: integer
      description: 宿主机上网卡数量
    manufacture:
      type: string
      description: 宿主机厂商信息