跳转到主要内容
API Explorer|API Explorer
计算管理/主机相关接口/PCI设备相关接口
GETPCI Device Related APIs起始版本 2.1同步需要认证

获取PCI设备列表

获取PCI设备列表

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

查询参数

请求参数

路径参数

  • vmInstanceUuidString必填

    虚拟机UUID

查询参数

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

  • typesList

    类型。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • hostUuidString必填

      主机UUID

    • parentUuidString必填

      物理PCI设备UUID

    • vmInstanceUuidString必填

      虚拟机UUID

    • pciSpecUuidString必填

      PCI设备规格UUID

    • vendorIdString必填

      供应商ID

    • deviceIdString必填

      设备ID

    • subvendorIdString必填

      子供应商ID

    • subdeviceIdString必填

      子设备ID

    • pciDeviceAddressString必填

      PCI设备地址

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • typePciDeviceType必填

      详情参考type

      • GPU_Video_ControllerPciDeviceType必填

        GPU显卡控制器

      • GPU_Audio_ControllerPciDeviceType必填

        GPU声卡控制器

      • GPU_3D_ControllerPciDeviceType必填

        GPU 3D控制器

      • Moxa_DevicePciDeviceType必填

        MOXA卡

      • GenericPciDeviceType必填

        一般设备

    • statePciDeviceState必填

      详情参考state

      • EnabledPciDeviceState必填

        启用

      • DisabledPciDeviceState必填

        停用

    • statusPciDeviceStatus必填

      详情参考status

      • ActivePciDeviceStatus必填

        就绪

      • AttachedPciDeviceStatus必填

        已挂载

      • SystemPciDeviceStatus必填

        系统

    • virtStatusPciDeviceVirtStatus必填

      详情参考virtStatus

      • UNVIRTUALIZABLEPciDeviceVirtStatus必填

        不可虚拟化

      • SRIOV_VIRTUALIZABLEPciDeviceVirtStatus必填

        支持SRIOV虚拟化

      • VFIO_MDEV_VIRTUALIZABLEPciDeviceVirtStatus必填

        支持VFIO_MDEV虚拟化

      • SRIOV_VIRTUALIZEDPciDeviceVirtStatus必填

        已SRIOV虚拟化

      • VFIO_MDEV_VIRTUALIZEDPciDeviceVirtStatus必填

        已VFIO_MDEV虚拟化

      • SRIOV_VIRTUALPciDeviceVirtStatus必填

        SRIOV虚拟设备

      • UNKNOWNPciDeviceVirtStatus必填

        未知

    • chooserPciDeviceChooser必填

      详情参考chooser

      • NonePciDeviceChooser必填

        无。

      • DevicePciDeviceChooser必填

        设备。

      • SpecPciDeviceChooser必填

        规格。

    • metaDataPciDeviceMetaData必填

      详情参考metaData

      • metaDataString必填

        元数据。

      • metaDataEntriesList必填

        详情参考metaDataEntries

        • keyString必填

          键

        • valueString必填

          值

        • opPciDeviceMetaDataOperator必填

          详情参考op

          • EqualPciDeviceMetaDataOperator必填

            相等

          • UnequalPciDeviceMetaDataOperator必填

            不等

    • matchedPciDeviceOfferingRefList必填

      详情参考matchedPciDeviceOfferingRef

      • pciDeviceUuidString必填

        暂无描述。

      • pciDeviceOfferingUuidString必填

        暂无描述。

    • mdevSpecRefsList必填

      详情参考mdevSpecRefs

      • pciDeviceUuidString必填

        PCI设备UUID

      • mdevSpecUuidString必填

        MDEV设备规格UUID

      • effectiveBoolean必填

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

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

GET/zstack/v1/vm-instances/{vmInstanceUuid}/candidate-pci-devices

/zstack/v1/vm-instances/{vmInstanceUuid}/candidate-pci-devices

操作 ID

GetPciDeviceCandidatesForAttachingVm

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/{vmInstanceUuid}/candidate-pci-devices?systemTags=<systemTags>&userTags=<userTags>&types=<types>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "200cc14b3ed5333da32607a09e8a75cb", "hostUuid": "0014ffc881a33fafb9723c9bcd4de3cd", "type": "GPU_Video_Controller", "status": "Attached", "vendorId": "10de", "deviceId": "0e0f", "subvendorId": "10de", "subdeviceId": "118b", "pciDeviceAddress": "0000:06:00.1" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史