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

Get Available MDEV Device Spec Candidates

Get Available MDEV Device Spec Candidates

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • clusterUuidsList

    Cluster UUID

  • hostUuidString

    Host UUID

  • vmInstanceUuidString

    VM Instance UUID

  • vmInstanceUuidsList

    VM Instance UUID List

  • typesList

    Device Type

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, 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

    • specificationStringRequired

      Specification details

    • createDateTimestampRequired

      Create date

    • lastOpDateTimestampRequired

      Last modified date

    • typeMdevDeviceTypeRequired

      See type

      • GPU_Video_ControllerMdevDeviceTypeRequired

        GPU video controller

    • stateMdevDeviceSpecStateRequired

      See state

      • EnabledMdevDeviceSpecStateRequired

        Enabled

      • DisabledMdevDeviceSpecStateRequired

        Disabled

Endpoint

GET/zstack/v1/mdev-device-specs/candidates

/zstack/v1/mdev-device-specs/candidates

Operation ID

GetMdevDeviceSpecCandidates

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/mdev-device-specs/candidates?clusterUuids=<clusterUuids>&hostUuid=<hostUuid>&vmInstanceUuid=<vmInstanceUuid>&vmInstanceUuids=<vmInstanceUuids>&types=<types>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "b6051f3e98c143d1bee891ff69f8fad4", "name": "GRID_M60-2A", "specification": "{Max Resolution\u003d1920*1080, GRID License\u003dGRID-Virtual-Apps,3.0, Instance Number\u003d4, Display Heads\u003d4, Vendor\u003dNVIDIA, Frame Rate Limit\u003d60FPS, Name\u003dGRID_M60-2A, RAM\u003d2048MB}", "type": "GPU_Video_Controller", "state": "Enabled", "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