cloudpods/docs/schemas/storage.yaml

StorageCreate:
  type: object
  properties:
    name:
      type: string
      example: test-storage
      description: 存储名称
    zone:
      type: string
      example: zone1
      description: 区域名称或ID
    medium_type:
      type: string
      example: ssd
      enum: [ssd,rotate]
      description: 介质类型
    capacity:
      type: integer
      example: 10240
      description: 存储容量(单位MB)
    storage_type:
      type: string
      example: local
      enum: [local,nas,vsan,rbd,nfs,gpfs,baremetal]
      description: 存储集群类型
    rbd_mon_host:
      type: string
      example: 10.127.10.230,10.127.10.237,10.127.10.238
      description: Ceph mon_host config, 仅存储类型是rbd时有用
    rbd_key:
      type: string
      example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw==
      description: Ceph key config, 仅存储类型是rbd时有用
    rbd_pool:
      type: string
      example: test-pool
      description: Ceph pool name, 仅存储类型是rbd时有用
    rbd_rados_mon_op_timeout:
      type: string
      example: 10
      default: 5
      description: Ceph集群连接超时时间, 仅存储类型是rbd时有用
    rbd_rados_osd_op_timeout:
      type: string
      example: 3600
      default: 1200
      description: Ceph块存储操作超时时间, 仅存储类型是rbd时有用
    rbd_client_mount_timeout:
      type: string
      example: 60
      default: 120
      description: CephFS挂载超时时间, 仅存储类型是rbd时有用
    nfs_host:
      type: string
      description: NFS host address
    nfs_share_dir:
      type: string
      description: NFS shared dir

StorageResponse:
  type: object
  properties:
    storage:
      type: object
      $ref: '#/Storage'

Storage:
  type: object
  description: 存储
  properties:
    id:
      type: string
      example: f227c4ce-6870-19f3-8257-f53e63f40361
      description: 存储uuid
      readOnly: true
    name:
      type: string
      description: 存储名称
      example: storage-r4hilqks
      readOnly: true
    brand:
      type: string
      example: OneCloud
      description: 虚拟化品牌
    can_delete:
      type: boolean
      description: 是否可删除
    can_update:
      type: boolean
      description: 是否可以更新资源属性
    created_at:
      type: string
      example: 2019-05-30T02:25:38.000000Z
      description: 资源创建时间
    is_emulated:
      type: boolean 
      example: false
      description: 是否是虚拟出来的存储
    provider:
      type: string 
      example: Qcloud
      description: 纳管云平台
    region:
      type: string 
      example: region1
      description: 区域名称
    region_id:
      type: string 
      example: 13947bd8-569e-4094-8b03-4339c2a8e45b
      description: 区域ID
    zone:
      type: string 
      example: zone1
      description: 可用区名称
    zone_id:
      type: string 
      example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc
      description: 可用区ID
    update_version:
      type: integer 
      example: 2
      description: 资源被更新的次数
    updated_at:
      type: string 
      example: 2019-05-30T06:36:39.000000Z
      description: 资源最近一次更新时间
    status:
      type: string 
      example: offline
      description: 存储状态
    medium_type:
      type: string
      example: ssd
      description: 介质类型
    capacity:
      type: integer
      example: 10240
      description: 存储容量(单位MB)
    storage_type:
      type: string
      example: local
      description: 存储集群类型
    free_capacity:
      type: integer
      example: 10240
      description: 剩余存储容量(单位MB)
    cmtbound:
      type: float
      example: 1.000000
      description: 超售比
    commit_bound:
      type: float
      example: 1.000000
      description: 超售比
    commit_rate:
      type: float
      example: 0.000000
      description: 已分配比率
    is_sys_disk_store:
      type: boolean
      example: false
      description: 系统盘存储
    reserved:
      type: integer
      example: 1024
      description: 预留存储大小
    storagecache_id:
      type: string
      example: 7cf5c609-6435-4ef6-8845-882946aeb1a7
      description: 缓存ID
    virtual_capacity:
      type: integer
      example: 201456
      description: 虚拟容量大小
    waste_capacity:
      type: integer
      example: 12345
      description: 已使用容量大小
    enable:
      type: boolean
      example: true
      description: 存储是否可用
    desc:
      type: string
      example: this is test storage
      description: 存储描述信息

StorageListResponse:
  type: object
  properties:
    limit: 
      type: integer
      example: 20
    storages:
      type: array
      items:
        $ref: '#/Storage'
    total:
      type: integer
      example: 124


StorageUpdate:
  type: object
  properties:
    name:
      type: string
      example: test-storage
      description: 存储名称
    storage_type:
      type: string
      example: local
      enum: [local,nas,vsan,rbd,nfs,gpfs,baremetal]
      description: 存储集群类型
    medium_type:
      type: string
      example: ssd
      description: 介质类型
    commit_bound:
      type: float
      example: 1.000000
      description: 超售比
    reserved:
      type: integer
      example: 1024
      description: 预留存储大小
    desc:
      type: string
      example: this is test storage
      description: 存储描述信息
    rbd_key:
      type: string
      description: Ceph key config
    rbd_rados_mon_op_timeout:
      type: string
      example: 10
      description: Ceph集群连接超时时间
    rbd_rados_osd_op_timeout:
      type: string
      example: 3600
      description: Ceph块存储操作超时时间
    rbd_client_mount_timeout:
      type: string
      example: 60
      description: CephFS挂载超时时间