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 Spec to Virtual Machine

Attach MDEV Device Spec to Virtual Machine

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • mdevSpecUuidStringRequired

    MDEV device spec UUID

  • vmInstanceUuidStringRequired

    Virtual Machine UUID

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • mdevDeviceNumberInteger

      No description provided.

  • 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

  • inventoryVmInstanceMdevDeviceSpecRefInventoryRequired

    See inventory

    • vmInstanceUuidStringRequired

      Virtual Machine UUID

    • mdevSpecUuidStringRequired

      MDEV device spec UUID

    • mdevDeviceNumberIntegerRequired

      Number of mdev devices that meet the spec to attach to the VM, defaults to 1

    • createDateTimestampRequired

      Create date

    • lastOpDateTimestampRequired

      Last update date

Endpoint

POST/zstack/v1/mdev-device-specs/{mdevSpecUuid}/vm-instances/{vmInstanceUuid}

/zstack/v1/mdev-device-specs/{mdevSpecUuid}/vm-instances/{vmInstanceUuid}

Operation ID

AddMdevDeviceSpecToVmInstance

Permalink

Request Example

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

Response Example

200
{ "inventory": { "vmInstanceUuid": "0f3a0fd4cd7646afb445e601e885b83e", "mdevSpecUuid": "621c2f8c637b4d7ebbfe5a55f60c8a60", "mdevDeviceNumber": 1, "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