跳转到主要内容
资源中心/云资源池/云主机相关接口

从云盘创建云主机

从云盘创建云主机

POST/zstack/v1/vm-instances/from/volume

操作 ID

CreateVmInstanceFromVolume

起始版本

3.10.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • name
      String必填

      资源名称

    • description
      String

      资源的详细描述

    • instanceOfferingUuid
      String

      计算规格UUID,注意:该参数与CPU数量、内存大小二选一

    • cpuNum
      Integer

      CPU核数,单位为GB,该参数与instanceOfferingUuid二选一

    • memorySize
      Long

      内存大小,单位为Byte,该参数与instanceOfferingUuid二选一

    • l3NetworkUuids
      List必填

      三层网络UUID 可指定一个或多个三层网络,云主机会在每个三层网络上创建一个网卡。

    • type
      String

      云主机类型 保留字段,无需指定。

    • volumeUuid
      String必填

      云盘UUID

    • platform
      String

      云盘系统平台

    • zoneUuid
      String

      区域UUID 若指定,云主机会在指定区域创建。

    • clusterUuid
      String

      集群UUID 若指定,云主机会在指定集群创建,该字段优先级高于zoneUuid。

    • hostUuid
      String

      物理机UUID 若指定,云主机会在指定物理机创建,该字段优先级高于zoneUuid和clusterUuid。

    • primaryStorageUuid
      String

      主存储UUID 若指定,云主机的根云盘会在指定主存储创建。

    • defaultL3NetworkUuid
      String

      默认三层网络UUID 当l3NetworkUuids指定了多个三层网络时,该字段指定提供默认路由的三层网络。 若不指定,l3NetworkUuids的第一个网络被选为默认网络。

    • strategy
      String

      云主机创建策略 创建后立刻启动 创建后不启动

    • resourceUuid
      String

      资源UUID 若指定,云主机会使用该字段值作为UUID。

    • tagUuids
      List

      标签UUID列表

  • systemTags
    List

    云主机系统标签

  • userTags
    List

    云主机用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

      根错误,引发当前错误的源错误,若无原错误,该字段为null

  • inventory
    VmInstanceInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID,唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • zoneUuid
      String必填

      区域UUID

    • clusterUuid
      String必填

      集群UUID

    • imageUuid
      String必填

      镜像UUID

    • hostUuid
      String必填

      物理机UUID

    • lastHostUuid
      String必填

      最近一次主机UUID。

    • instanceOfferingUuid
      String必填

      计算规格UUID

    • rootVolumeUuid
      String必填

      根云盘UUID

    • platform
      String必填

      平台。

    • defaultL3NetworkUuid
      String必填

      默认三层3网络UUID。

    • type
      String必填

      类型。

    • hypervisorType
      String必填

      hypervisor类型。

    • memorySize
      Long必填

      内存大小。

    • cpuNum
      Integer必填

      暂无描述。

    • cpuSpeed
      Long必填

      暂无描述。

    • allocatorStrategy
      String必填

      allocator策略。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • state
      String必填

      当前状态。

    • vmNics
      List必填

      详情参考vmNics

      • uuid
        String必填

        资源的UUID,唯一标示该资源

      • vmInstanceUuid
        String必填

        云主机UUID

      • l3NetworkUuid
        String必填

        三层网络UUID

      • ip
        String必填

        ip地址

      • mac
        String必填

        mac地址

      • hypervisorType
        String必填

        虚拟化类型

      • netmask
        String必填

        子网掩码

      • gateway
        String必填

        网关

      • metaData
        String必填

        内部使用的保留域

      • ipVersion
        Integer必填

        IP地址版本

      • deviceId
        Integer必填

        设备ID

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • usedIps
        List必填

        详情参考usedIps

        • uuid
          String必填

          资源的UUID,唯一标示该资源

        • ipRangeUuid
          String必填

          IP段UUID

        • l3NetworkUuid
          String必填

          三层网络UUID

        • ipVersion
          Integer必填

          IP协议号

        • ip
          String必填

          IP地址

        • netmask
          String必填

          网络掩码

        • gateway
          String必填

          网关地址

        • usedFor
          String必填

          intended使用。

        • ipInLong
          long必填

          IP地址represented长integer。

        • vmNicUuid
          String必填

          云主机网卡UUID

        • createDate
          Timestamp必填

          创建时间

        • lastOpDate
          Timestamp必填

          最后一次修改时间

    • allVolumes
      List必填

      详情参考allVolumes

      • uuid
        String必填

        资源的UUID,唯一标示该资源

      • name
        String必填

        资源名称

      • description
        String必填

        资源的详细描述

      • primaryStorageUuid
        String必填

        主存储UUID

      • vmInstanceUuid
        String必填

        云主机UUID

      • diskOfferingUuid
        String必填

        云盘规格UUID

      • rootImageUuid
        String必填

        云盘根镜像UUID

      • installPath
        String必填

        云盘在主存储上的路径

      • type
        String必填

        云盘类型,数据云盘/根云盘

      • format
        String必填

        云盘格式

      • size
        Long必填

        云盘大小

      • actualSize
        Long必填

        云盘真实大小

      • deviceId
        Integer必填

        设备ID。

      • state
        String必填

        云盘是否开启

      • status
        String必填

        云盘状态

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • isShareable
        Boolean必填

        是否共享云盘

      • volumeQos
        String必填

        云盘Qos,格式如total=1048576