Get Available MDEV Devices

GET/zstack/v1/mdev-devices/candidates

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/mdev-devices/candidates?vmInstanceUuid=3be91dd3332a3ef0b57831dcfc28a0c2&types=GPU_Video_Controller

Parameter List

Name	Type	Location	Description	Starting Version
clusterUuids (Optional)	List	query	Cluster UUID	3.5.0
hostUuid (Optional)	String	query	Host UUID	3.5.0
vmInstanceUuid (Optional)	String	query	Virtual Machine UUID	3.5.0
types (Optional)	List	query	Device type	3.5.0
systemTags (Optional)	List	query	System tags	3.5.0
userTags (Optional)	List	query	User tags	3.5.0

API Response

Response Example

{
  "inventories": [
    {
      "uuid": "ff09c7d3eb084e0c92d91f91559b0015",
      "name": "GRID M60-2A",
      "parentUuid": "cd35f76c62ec4e0ca5af3f93434f9410",
      "hostUuid": "55c3da7722a442fcbf5cc2373cb45dc7",
      "mdevSpecUuid": "55d7980cf5604dd6b45e2946fa75a312",
      "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"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		0.6
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. See error	3.5.0
inventories	List	See inventories	3.5.0

error

Name	Type	Description	Starting Version
code	String	Error code, a globally unique identifier of the error, e.g. SYS.1000, HOST.1001	3.5.0
description	String	Brief description of the error	3.5.0
details	String	Detailed error information	3.5.0
elaboration	String	Reserved field, defaults to null	3.5.0
opaque	LinkedHashMap	Reserved field, defaults to null	3.5.0
cause	ErrorCode	Root cause, the source error that caused the current error, null if no original error	3.5.0

inventories

Name	Type	Description	Starting Version
uuid	String	UUID of the resource, uniquely identifies the resource	3.5.0
name	String	Resource name	3.5.0
description	String	Resource description	3.5.0
parentUuid	String	Physical PCI device UUID	3.5.0
hostUuid	String	Host UUID	3.5.0
vmInstanceUuid	String	Virtual Machine UUID	3.5.0
mdevSpecUuid	String	MDEV device spec UUID	3.5.0
createDate	Timestamp	Create date	3.5.0
lastOpDate	Timestamp	Last update date	3.5.0
type	MdevDeviceType	See type	3.5.0
state	MdevDeviceState	See state	3.5.0
status	MdevDeviceStatus	See status	3.5.0
chooser	MdevDeviceChooser	See chooser	4.1.0

type

Name	Type	Description	Starting Version
GPU_Video_Controller	MdevDeviceType	GPU video controller	3.5.0

state

Name	Type	Description	Starting Version
Enabled	MdevDeviceState	Enabled	3.5.0
Disabled	MdevDeviceState	Disabled	3.5.0

status

Name	Type	Description	Starting Version
Active	MdevDeviceStatus	Ready	3.5.0
Attached	MdevDeviceStatus	Attached	3.5.0

chooser

Name	Type	Starting Version
None	PciDeviceChooser	4.2.0
Device	PciDeviceChooser	4.2.0
Spec	PciDeviceChooser	4.2.0

SDK Examples

Java SDK

GetMdevDeviceCandidatesAction action = new GetMdevDeviceCandidatesAction();
action.vmInstanceUuid = "3be91dd3332a3ef0b57831dcfc28a0c2";
action.types = asList("GPU_Video_Controller");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetMdevDeviceCandidatesAction.Result res = action.call();

Python SDK

GetMdevDeviceCandidatesAction action = GetMdevDeviceCandidatesAction()
action.vmInstanceUuid = "3be91dd3332a3ef0b57831dcfc28a0c2"
action.types = [GPU_Video_Controller]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetMdevDeviceCandidatesAction.Result res = action.call()