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

Attach Mdev Device Sliced from PCI Device to VM

Attach Mdev Device Sliced from PCI Device to VM

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • mdevDeviceUuidStringRequired

    MDEV device UUID

  • vmInstanceUuidStringRequired

    Virtual Machine UUID

Body Fields

  • systemTagsList

    System tags

  • userTagsList

    User tags

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

  • inventoryMdevDeviceInventoryRequired

    See inventory

    • uuidStringRequired

      UUID of the resource, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Resource description

    • parentUuidStringRequired

      Physical PCI device UUID

    • hostUuidStringRequired

      Host UUID

    • vmInstanceUuidStringRequired

      Virtual Machine UUID

    • mdevSpecUuidStringRequired

      MDEV device spec UUID

    • createDateTimestampRequired

      Create date

    • lastOpDateTimestampRequired

      Last update date

    • typeMdevDeviceTypeRequired

      See type

      • GPU_Video_ControllerMdevDeviceTypeRequired

        GPU video controller

    • stateMdevDeviceStateRequired

      See state

      • EnabledMdevDeviceStateRequired

        Enabled

      • DisabledMdevDeviceStateRequired

        Disabled

    • statusMdevDeviceStatusRequired

      See status

      • ActiveMdevDeviceStatusRequired

        Ready

      • AttachedMdevDeviceStatusRequired

        Attached

    • chooserMdevDeviceChooserRequired

      See chooser

      • NonePciDeviceChooserRequired

        无。

      • DevicePciDeviceChooserRequired

        设备。

      • SpecPciDeviceChooserRequired

        规格。

Endpoint

POST/zstack/v1/mdev-devices/{mdevDeviceUuid}/vm-instances/{vmInstanceUuid}

/zstack/v1/mdev-devices/{mdevDeviceUuid}/vm-instances/{vmInstanceUuid}

Operation ID

AttachMdevDeviceToVm

Permalink

Request Example

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

Response Example

200
{ "inventory": { "uuid": "0eae7167f0db486aace15529dbc38be9", "name": "GRID M60-2A", "parentUuid": "9ab8975b943f4b8f82450629386ddf74", "hostUuid": "f6db3ae1ef974f539b340851b11bb750", "mdevSpecUuid": "c4ee001ad1924cc398f3d17c89a12bfb", "type": "GPU_Video_Controller", "state": "Enabled", "status": "Active", "chooser": "None", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

Change History

This API has no change history records yet.

View all change history