查询PCI设备(QueryPciDevice)

API请求

URL

GET zstack/v1/pci-device/pci-devices
GET zstack/v1/pci-device/pci-devices/{uuid}

Header

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 043ef942ef97460bba5c9381bb7a7455" \
-X GET http://localhost:8080/zstack/v1/pci-device/pci-devices

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 4af958832a32465aa544c3d7722af1da" \
-X GET http://localhost:8080/zstack/v1/pci-device/pci-devices/5b39eaae24e84e4ca7eb0bc56d6827c1

可查询字段

运行CLI命令行工具，输入QueryPciDevice并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {}
  ]
}


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

#error


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

#inventories


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.1
name	String	资源名称	3.5.0
description	String	资源的详细描述	2.1
hostUuid	String	物理机UUID	2.1
parentUuid	String	物理PCI设备UUID	3.5.0
vmInstanceUuid	String	云主机UUID	2.1
pciSpecUuid	String	PCI设备规格UUID	3.5.0
vendorId	String	供应商ID	2.1
deviceId	String	设备ID	2.1
subvendorId	String	子供应商ID	2.1
subdeviceId	String	子设备ID	2.1
pciDeviceAddress	String	PCI设备地址	2.1
createDate	Timestamp	创建时间	2.1
lastOpDate	Timestamp	最后一次修改时间	2.1
type	PciDeviceType	详情参考type	2.1
state	PciDeviceState	详情参考state	2.1
status	PciDeviceStatus	详情参考status	2.1
virtStatus	PciDeviceVirtStatus	详情参考virtStatus	3.5.0
metaData	PciDeviceMetaData	详情参考metaData	2.1
matchedPciDeviceOfferingRef	List	详情参考matchedPciDeviceOfferingRef	2.1
mdevSpecRefs	List	详情参考mdevSpecRefs	3.5.0

#type


名字	类型	描述	起始版本
GPU_Video_Controller	PciDeviceType	GPU显卡控制器	2.1
GPU_Audio_Controller	PciDeviceType	GPU声卡控制器	2.1
GPU_3D_Controller	PciDeviceType	GPU 3D控制器	2.1
Moxa_Device	PciDeviceType	MOXA卡	2.1
Generic	PciDeviceType	一般设备	2.1

#state


名字	类型	描述	起始版本
Enabled	PciDeviceState	启用	2.1
Disabled	PciDeviceState	停用	2.1

#status


名字	类型	描述	起始版本
Active	PciDeviceStatus	就绪	2.1
Attached	PciDeviceStatus	已挂载	2.1
System	PciDeviceStatus	系统	2.1

#virtStatus


名字	类型	描述	起始版本
UNVIRTUALIZABLE	PciDeviceVirtStatus	不可虚拟化	3.5.0
SRIOV_VIRTUALIZABLE	PciDeviceVirtStatus	支持SRIOV虚拟化	3.5.0
VFIO_MDEV_VIRTUALIZABLE	PciDeviceVirtStatus	支持VFIO_MDEV虚拟化	3.5.0
SRIOV_VIRTUALIZED	PciDeviceVirtStatus	已SRIOV虚拟化	3.5.0
VFIO_MDEV_VIRTUALIZED	PciDeviceVirtStatus	已VFIO_MDEV虚拟化	3.5.0
SRIOV_VIRTUAL	PciDeviceVirtStatus	SRIOV虚拟设备	3.5.0
UNKNOWN	PciDeviceVirtStatus	未知	3.5.0

#metaData


名字	类型	描述	起始版本
metaData	String		2.1
metaDataEntries	List	详情参考metaDataEntries	2.1

#metaDataEntries


名字	类型	描述	起始版本
key	String	键	2.1
value	String	值	2.1
op	PciDeviceMetaDataOperator	详情参考op	2.1

#op


名字	类型	描述	起始版本
Equal	PciDeviceMetaDataOperator	相等	2.1
Unequal	PciDeviceMetaDataOperator	不等	2.1

#matchedPciDeviceOfferingRef


名字	类型	描述	起始版本
pciDeviceUuid	String		2.1
pciDeviceOfferingUuid	String		2.1

#mdevSpecRefs


名字	类型	描述	起始版本
pciDeviceUuid	String	PCI设备UUID	3.5.0
mdevSpecUuid	String	MDEV设备规格UUID	3.5.0
effective	Boolean	当前MDEV规格是否被用于切分该PCI设备	3.5.0
createDate	Timestamp	创建时间	3.5.0
lastOpDate	Timestamp	最后一次修改时间	3.5.0

SDK示例

Java SDK

QueryPciDeviceAction action = new QueryPciDeviceAction();
action.conditions = asList();
action.sessionId = "9895783acb8541c6938417b602429219";
QueryPciDeviceAction.Result res = action.call();

Python SDK

QueryPciDeviceAction action = QueryPciDeviceAction()
action.conditions = []
action.sessionId = "515d02b3a2094575beadbf3db7127880"
QueryPciDeviceAction.Result res = action.call()