cloudpods/docs/schemas/disk.yaml

Disk:
  type: object
  description: 磁盘
  properties:
    id:
      type: string
      example: ea27c0ce-5870-49f3-8d57-f53e63f40361
      description: 磁盘uuid
      readOnly: true
    name:
      type: string
      description: 磁盘名称
      example: disk-r4hilqks
      readOnly: true
    billing_type:
      type: string
      description: 计费类型
      example: postpaid
      readOnly: true
    account:
      type: string
      example: office-qcloud
      description: 所属云账号名称
    account_id:
      type: string
      description: 所属云账号ID
    brand:
      type: string
      example: DStack
      description: 虚拟化品牌
    created_at:
      type: string
      example: 2019-05-30T02:25:38.000000Z
      description: 资源创建时间
    external_id:
      type: string
      example: disk-r4hilqks
      description: 磁盘外部ID，对应的纳管云磁盘ID
    pending_deleted:
      type: boolean
      example: false
      description: 是否在回收站
    provider:
      type: string 
      example: Qcloud
      description: 纳管云平台
    region:
      type: string 
      example: 腾讯云 华南地区(广州)
      description: 区域名称
    region_id:
      type: string 
      example: 13947bd8-569e-4094-8b03-4339c2a8e45b
      description: 区域ID
    status:
      type: string 
      example: ready
      description: 资源状态
    tenant:
      type: string 
      example: system
      description: 归属项目名称
    tenant_id:
      type: string 
      example: 29541006ae9148b9bf002fc294218022
      description: 归属项目ID
    update_version:
      type: integer 
      example: 2
      description: 资源被更新的次数
    updated_at:
      type: string 
      example: 2019-05-30T06:36:39.000000Z
      description: 资源最近一次更新时间
    zone:
      type: string 
      example: 腾讯云 广州三区
      description: 可用区名称
    zone_ext_id:
      type: string 
      example: ap-guangzhou-3
      description: 可用区外部ID,对应纳管云可用区ID
    zone_id:
      type: string 
      example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc
      description: 可用区ID
    disk_format:
      type: string
      example: qcow2
      description: 磁盘类型qcow2, vmdk， vhd等
    disk_size:
      type: integer
      example: 10240
      description: 磁盘大小，单位MB
    access_path:
      type: string
      example: /opt/cloud/workspace/disks/a16d3e0b-3fd6-45ec-8b2d-e51a51fa0eff
      description: 磁盘存储的路径
    template_id:
      type: string
      example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0edd
      description: 磁盘所用镜像ID
    snapshot_id:
      type: string
      example: a16d3e0b-3fd6-45ec-8b2d-e51a51faccdd
      description: 磁盘所用快照ID
    fs_format:
      type: string
      example: ext3
      description: 磁盘分区类型
    disk_type:
      type: string
      example: system
      description: 磁盘类型，系统盘，数据盘和交换分区

DiskResponse:
  type: object
  properties:
    disk:
      type: object
      $ref: '#/Disk'

DiskListResponse:
  type: object
  properties:
    limit: 
      type: integer
      example: 20
    disks:
      type: array
      items:
        $ref: '#/Disk'
    total:
      type: integer
      example: 124

DiskUpdate:
  type: object
  properties:
    name:
      type: string
      example: other-name
    desc:
      type: string
      description: desc of this disk
    auto_delete:
      type: string
      enum: [enable, disable]
    disk_type:
      type: string
      enum: [data, volume]

DiskResize:
  type: object
  properties:
    size:
      type: integer
      example: 20G
      description: 扩容后磁盘大小

DiskSave:
  type: object
  properties:
    name:
      type: string
      example: centos
      description: 镜像名称
    public:
      type: boolean
      example: true
      description: 是否共享
    format:
      type: string
      example: qcow2
      enum: [vmdk, qocw2]
      description: 镜像格式
    notes:
      type: string
      description: notes about the image
    os_type:
      type: object
      $ref: "#/OsType"

OsType:
  type: object
  properties:
    properties:
      type: string
      enum: [Linux,Windows,VMware]
      description: 镜像操作系统类型

DiskReset:
  type: object
  required: [snapshot_id]
  properties:
    auto_start:
      type: boolean
      description: 回滚磁盘后自动启动虚拟机
    snapshot_id:
      type: string
      description: 要回滚的快照Id

DiskCreate:
  type: object
  properties:
    prefer_region:
      type: string
      example: Default
      description: 区域名称或ID(指定调度区域，若此区域资源不足会导致磁盘创建失败)
    prefer_zone:
      type: string
      example: Zone-1
      description: 可用区名称或ID(指定调度可用区，若此可用区资源不足会导致磁盘创建失败,此优先级高于prefer_region)
    prefer_host:
      type: string
      example: e621b7c6-cb38-48a3-81bd-1f3a9cc07161
      description: 宿主机名称或ID(指定调度宿主机，若宿主机上资源不足会导致磁盘创建失败,此优先级高于prefer_zone)
    prefix_wire:
      type: string
      example: 572f250d-5a68-4471-8c1a-02568c7920fb
      description: 二层网络名称或ID(指定关联的二层网络,优先级高于prefer_zone)
    name:
      type: string
      example: test-disk
      description: 磁盘名称
    hypervisor:
      type: string
      example: qcloud
      enum: [kvm,esxi,baremetal,container,aliyun,azure,qcloud,aws,huawei,openstack,ucloud,zstack]
      description: 指定创建磁盘平台
    size:
      type: integer
      example: 10240
      description: disk size 单位MB
    fs:
      type: string
      example: ext4
      description: 磁盘分区格式
    format:
      type: string
      example: qcow2
      description: 磁盘格式
    driver:
      type: string
      example: scsi
      description: 磁盘驱动类型
    backend:
      type: string
      example: local
      description: 存储格式

DiskCreateSanpshot:
  type: object
  properties:
    name:
      type: string
      description: snapshot name