获取可用的MDEV设备(GetMdevDeviceCandidates)

API请求

URLs

GET zstack/v1/mdev-devices/candidates

Headers

Authorization: OAuth the-session-uuid

Curl示例

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

参数列表


名字	类型	位置	描述	起始版本
clusterUuids (可选)	List	query	集群UUID	3.5.0
hostUuid (可选)	String	query	物理机UUID	3.5.0
vmInstanceUuid (可选)	String	query	云主机UUID	3.5.0
types (可选)	List	query	设备类型	3.5.0
systemTags (可选)	List	query	系统标签	3.5.0
userTags (可选)	List	query	用户标签	3.5.0

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "4dd1f251873b4173939179c29b864df0",
      "name": "GRID M60-2A",
      "parentUuid": "36ff3d337d644bb9803f6599ec77189c",
      "hostUuid": "f1c21432e12245e78ee05324bb0886b4",
      "mdevSpecUuid": "8c9ddca8f93d4457acf78194986f8034",
      "type": "GPU_Video_Controller",
      "state": "Enabled",
      "status": "Active",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}


名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.5.0
inventories	List	详情参考inventories	3.5.0

#error


名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	3.5.0
description	String	错误的概要描述	3.5.0
details	String	错误的详细信息	3.5.0
elaboration	String	保留字段，默认为null	3.5.0
opaque	LinkedHashMap	保留字段，默认为null	3.5.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	3.5.0

#inventories


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.5.0
name	String	资源名称	3.5.0
description	String	资源的详细描述	3.5.0
parentUuid	String	物理PCI设备UUID	3.5.0
hostUuid	String	物理机UUID	3.5.0
vmInstanceUuid	String	云主机UUID	3.5.0
mdevSpecUuid	String	MDEV设备规格UUID	3.5.0
createDate	Timestamp	创建时间	3.5.0
lastOpDate	Timestamp	最后一次修改时间	3.5.0
type	MdevDeviceType	详情参考type	3.5.0
state	MdevDeviceState	详情参考state	3.5.0
status	MdevDeviceStatus	详情参考status	3.5.0

#type


名字	类型	描述	起始版本
GPU_Video_Controller	MdevDeviceType	GPU显卡控制器	3.5.0

#state


名字	类型	描述	起始版本
Enabled	MdevDeviceState	启用	3.5.0
Disabled	MdevDeviceState	停用	3.5.0

#status


名字	类型	描述	起始版本
Active	MdevDeviceStatus	就绪	3.5.0
Attached	MdevDeviceStatus	已挂载	3.5.0

SDK示例

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()