Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/Host Operations/PCI Device Operations
POSTPCI Device OperationsSince 2.1SynchronousAuth Required

AttachPciDeviceToVm

AttachPciDeviceToVm

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • pciDeviceUuidStringRequired

    The PCI device UUID.

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • vmInstanceUuidStringRequired

      The VM instance UUID.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryPciDeviceInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • hostUuidStringRequired

      The host UUID.

    • parentUuidStringRequired

      The UUID of the physical PCI device.

    • vmInstanceUuidStringRequired

      The VM instance UUID.

    • vendorIdStringRequired

      The vendor ID.

    • pciSpecUuidStringRequired

      The UUID of the PCI device specification.

    • deviceIdStringRequired

      The device ID.

    • subvendorIdStringRequired

      The sub-vendor ID.

    • subdeviceIdStringRequired

      The sub-device ID.

    • pciDeviceAddressStringRequired

      The PCI device address.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • statusPciDeviceStatusRequired

      See status.

      • ActivePciDeviceStatusRequired

        The PCI device is active.

      • AttachedPciDeviceStatusRequired

        The PCI device is active.

      • SystemPciDeviceStatusRequired

        The PCI device is managed by the system.

    • statePciDeviceStateRequired

      See state.

      • EnabledPciDeviceStateRequired

        The PCI device is enabled.

      • DisabledPciDeviceStateRequired

        The PCI device is disabled.

    • typePciDeviceTypeRequired

      See type.

      • GPU_Video_ControllerPciDeviceTypeRequired

        The GPU video controller.

      • GPU_Audio_ControllerPciDeviceTypeRequired

        The GPU audio controller.

      • GPU_3D_ControllerPciDeviceTypeRequired

        The GPU 3D controller.

      • Moxa_DevicePciDeviceTypeRequired

        The MOXA card.

      • GenericPciDeviceTypeRequired

        The general device.

    • virtStatusPciDeviceVirtStatusRequired

      See virtStatus.

      • UNVIRTUALIZABLEPciDeviceVirtStatusRequired

        Cannot be virtualized.

      • SRIOV_VIRTUALIZABLEPciDeviceVirtStatusRequired

        Supports SR-IOV.

      • VFIO_MDEV_VIRTUALIZABLEPciDeviceVirtStatusRequired

        Supports VFIO MDEV.

      • SRIOV_VIRTUALIZEDPciDeviceVirtStatusRequired

        Has been virtualized by SR-IOV.

      • VFIO_MDEV_VIRTUALIZEDPciDeviceVirtStatusRequired

        Has been virtualized by VFIO MDEV.

      • SRIOV_VIRTUALPciDeviceVirtStatusRequired

        The SR-IOV device.

      • UNKNOWNPciDeviceVirtStatusRequired

        The status is unknown.

    • metaDataPciDeviceMetaDataRequired

      See metaData.

      • metaDataStringRequired

        元数据。

      • metaDataEntriesListRequired

        See metaDataEntries.

        • keyStringRequired

          键。

        • valueStringRequired

          字段值。

        • opPciDeviceMetaDataOperatorRequired

          See op.

          • EqualPciDeviceMetaDataOperatorRequired

            The equal operator.

          • UnequalPciDeviceMetaDataOperatorRequired

            The not equal operator.

    • matchedPciDeviceOfferingRefListRequired

      See matchedPciDeviceOfferingRef.

      • pciDeviceUuidStringRequired

        No description provided.

      • pciDeviceOfferingUuidStringRequired

        No description provided.

    • mdevSpecRefsListRequired

      See mdevSpecRefs.

      • pciDeviceUuidStringRequired

        The PCI device UUID.

      • mdevSpecUuidStringRequired

        The UUID of the MDEV device specification.

      • effectiveBooleanRequired

        Whether the current MDEV device specification is used to segment the PCI device.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

POST/zstack/v1/pci-device/pci-devices/{pciDeviceUuid}/attach

/zstack/v1/pci-device/pci-devices/{pciDeviceUuid}/attach

Operation ID

AttachPciDeviceToVm

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/pci-device/pci-devices/{pciDeviceUuid}/attach' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"vmInstanceUuid":"<vmInstanceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "4d0454694e264b2cafaa2adfd3e48602", "hostUuid": "b17bee8ff0814edc9661a65b281d2d78", "vmInstanceUuid": "ca4f71e2328f4f06b78d5b7255342dde", "status": "Attached", "type": "GPU_Video_Controller", "vendorId": "10de", "deviceId": "0e0f", "subvendorId": "10de", "subdeviceId": "118b", "pciDeviceAddress": "0000:06:00.1" } }

Change History

This API has no change history records yet.

View all change history