跳转到主要内容
ZStack
资源中心/硬件设施/物理机相关接口/PCI设备相关接口

获取可加载PCI设备

为新建虚拟机获取可加载PCI设备。

GET/zstack/v1/pci-device/candidate-pci-devices-for-new-create-vm

操作 ID

GetPciDeviceCandidatesForNewCreateVm

起始版本

2.4

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • hostUuid
    String

    物理机UUID

  • clusterUuids
    List

    暂无描述。

  • types
    List

    可选类型。

  • systemTags
    List

    系统标签。

  • userTags
    List

    用户标签。

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

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

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • hostUuid
      String必填

      物理机UUID

    • parentUuid
      String必填

      物理PCI设备UUID

    • vmInstanceUuid
      String必填

      云主机UUID

    • pciSpecUuid
      String必填

      PCI设备规格UUID

    • vendorId
      String必填

      供应商ID

    • deviceId
      String必填

      设备ID

    • subvendorId
      String必填

      子供应商ID

    • subdeviceId
      String必填

      子设备ID

    • pciDeviceAddress
      String必填

      PCI设备地址

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • type
      PciDeviceType必填

      详情参考type

      • GPU_Video_Controller
        PciDeviceType必填

        GPU显卡控制器

      • GPU_Audio_Controller
        PciDeviceType必填

        GPU声卡控制器

      • GPU_3D_Controller
        PciDeviceType必填

        GPU 3D控制器

      • Moxa_Device
        PciDeviceType必填

        MOXA卡

      • Generic
        PciDeviceType必填

        一般设备

    • state
      PciDeviceState必填

      详情参考state

      • Enabled
        PciDeviceState必填

        启用

      • Disabled
        PciDeviceState必填

        停用

    • status
      PciDeviceStatus必填

      详情参考status

      • Active
        PciDeviceStatus必填

        就绪

      • Attached
        PciDeviceStatus必填

        已挂载

      • System
        PciDeviceStatus必填

        系统

    • virtStatus
      PciDeviceVirtStatus必填

      详情参考virtStatus

      • UNVIRTUALIZABLE
        PciDeviceVirtStatus必填

        不可虚拟化

      • SRIOV_VIRTUALIZABLE
        PciDeviceVirtStatus必填

        支持SRIOV虚拟化

      • VFIO_MDEV_VIRTUALIZABLE
        PciDeviceVirtStatus必填

        支持VFIO_MDEV虚拟化

      • SRIOV_VIRTUALIZED
        PciDeviceVirtStatus必填

        已SRIOV虚拟化

      • VFIO_MDEV_VIRTUALIZED
        PciDeviceVirtStatus必填

        已VFIO_MDEV虚拟化

      • SRIOV_VIRTUAL
        PciDeviceVirtStatus必填

        SRIOV虚拟设备

      • UNKNOWN
        PciDeviceVirtStatus必填

        未知

    • metaData
      PciDeviceMetaData必填

      详情参考metaData

      • metaData
        String必填

        元数据。

      • metaDataEntries
        List必填

        详情参考metaDataEntries

        • key
          String必填

          键

        • value
          String必填

          值

        • op
          PciDeviceMetaDataOperator必填

          详情参考op

          • Equal
            PciDeviceMetaDataOperator必填

            相等

          • Unequal
            PciDeviceMetaDataOperator必填

            不等

    • matchedPciDeviceOfferingRef
      List必填

      详情参考matchedPciDeviceOfferingRef

      • pciDeviceUuid
        String必填

        pci设备UUID。

      • pciDeviceOfferingUuid
        String必填

        pci设备offering UUID。

    • mdevSpecRefs
      List必填

      详情参考mdevSpecRefs

      • pciDeviceUuid
        String必填

        PCI设备UUID

      • mdevSpecUuid
        String必填

        MDEV设备规格UUID

      • effective
        Boolean必填

        当前MDEV规格是否被用于切分该PCI设备

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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