Skip to main content
API Explorer|API Explorer
Compute Management/Host Related Interfaces/PCI Device Related APIs
GETPCI Device Related APIsSince 0.6SynchronousAuth Required

Query PCI Device

Query PCI Device

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null when the operation succeeds. See error

    • codeStringRequired

      Error code, a globally unique identifier of the error, e.g. SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause, the source error that caused the current error, null if no original error

  • inventoriesListRequired

    See inventories

    • uuidStringRequired

      UUID of the resource, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Resource description

    • hostUuidStringRequired

      Host UUID

    • parentUuidStringRequired

      Physical PCI device UUID

    • vmInstanceUuidStringRequired

      Virtual Machine UUID

    • pciSpecUuidStringRequired

      PCI device offering UUID

    • vendorIdStringRequired

      Vendor ID

    • deviceIdStringRequired

      Device ID

    • subvendorIdStringRequired

      Sub-vendor ID

    • subdeviceIdStringRequired

      Sub-device ID

    • pciDeviceAddressStringRequired

      PCI device address

    • createDateTimestampRequired

      Create date

    • lastOpDateTimestampRequired

      Last update date

    • typePciDeviceTypeRequired

      See type

      • GPU_Video_ControllerPciDeviceTypeRequired

        GPU video controller

      • GPU_Audio_ControllerPciDeviceTypeRequired

        GPU audio controller

      • GPU_3D_ControllerPciDeviceTypeRequired

        GPU 3D controller

      • Moxa_DevicePciDeviceTypeRequired

        MOXA card

      • GenericPciDeviceTypeRequired

        Generic device

    • statePciDeviceStateRequired

      See state

      • EnabledPciDeviceStateRequired

        Enabled

      • DisabledPciDeviceStateRequired

        Disabled

    • statusPciDeviceStatusRequired

      See status

      • ActivePciDeviceStatusRequired

        Ready

      • AttachedPciDeviceStatusRequired

        Attached

      • SystemPciDeviceStatusRequired

        System

    • virtStatusPciDeviceVirtStatusRequired

      See virtStatus

      • UNVIRTUALIZABLEPciDeviceVirtStatusRequired

        Unvirtualizable

      • SRIOV_VIRTUALIZABLEPciDeviceVirtStatusRequired

        SRIOV virtualizable

      • VFIO_MDEV_VIRTUALIZABLEPciDeviceVirtStatusRequired

        VFIO_MDEV virtualizable

      • SRIOV_VIRTUALIZEDPciDeviceVirtStatusRequired

        SRIOV virtualized

      • VFIO_MDEV_VIRTUALIZEDPciDeviceVirtStatusRequired

        VFIO_MDEV virtualized

      • SRIOV_VIRTUALPciDeviceVirtStatusRequired

        SRIOV virtual device

      • UNKNOWNPciDeviceVirtStatusRequired

        Unknown

    • chooserPciDeviceChooserRequired

      See chooser

      • NonePciDeviceChooserRequired

        无。

      • DevicePciDeviceChooserRequired

        设备。

      • SpecPciDeviceChooserRequired

        规格。

    • metaDataPciDeviceMetaDataRequired

      See metaData

      • metaDataStringRequired

        元数据。

      • metaDataEntriesListRequired

        See metaDataEntries

        • keyStringRequired

          Key

        • valueStringRequired

          Value

        • opPciDeviceMetaDataOperatorRequired

          See op

          • EqualPciDeviceMetaDataOperatorRequired

            Equal

          • UnequalPciDeviceMetaDataOperatorRequired

            Unequal

    • matchedPciDeviceOfferingRefListRequired

      See matchedPciDeviceOfferingRef

      • pciDeviceUuidStringRequired

        No description provided.

      • pciDeviceOfferingUuidStringRequired

        No description provided.

    • mdevSpecRefsListRequired

      See mdevSpecRefs

      • pciDeviceUuidStringRequired

        PCI device UUID

      • mdevSpecUuidStringRequired

        MDEV device offering UUID

      • effectiveBooleanRequired

        Whether the current MDEV specification is used to partition this PCI device

      • createDateTimestampRequired

        Create date

      • lastOpDateTimestampRequired

        Last update date

Endpoint

GET/zstack/v1/pci-device/pci-devices

/zstack/v1/pci-device/pci-devices

Operation ID

QueryPciDevice

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/pci-device/pci-devices' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ {} ] }

Change History

This API has no change history records yet.

View all change history