查询USB设备

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

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 54e99d3cba30426599008210fe537a5a" \
-X GET http://localhost:8080/zstack/v1/usb-device/usb-devices
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth bd2e6629c65f4be6b0ae893664d80fac" \
-X GET http://localhost:8080/zstack/v1/usb-device/usb-devices/d2da293d46ac46279168ae02b361c69f

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "0beadc00381c4ca09216dc2ebfb0fba3",
      "name": "usb",
      "hostUuid": "648749ea79fb412aab27712c5813600a",
      "vmInstanceUuid": "f862f3c01f3340d6ab68e7a79757342f",
      "state": "Enabled",
      "busNum": "001",
      "devNum": "001",
      "idVendor": "0781",
      "idProduct": "5591",
      "iManufacturer": "SanDisk",
      "iProduct": "Ultra USB 3.0",
      "iSerial": "000000000001",
      "usbVersion": "3.0",
      "attachType": "PassThrough"
    }
  ]
}
名字类型描述起始版本
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error2.2
inventoriesList详情参inventories2.2

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10012.2
descriptionString错误的概要描述2.2
detailsString错误的详细信息2.2
elaborationString保留字段,默认为null2.2
opaqueLinkedHashMap保留字段,默认为null2.2
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null2.2

inventories

名字类型描述起始版本
uuidString资源的UUID,唯一标示该资源2.2
nameString资源名称2.2
descriptionString资源的详细描述2.2
hostUuidString主机UUID2.2
vmInstanceUuidString虚拟机UUID2.2
busNumString总线号2.2
devNumString设备号2.2
idVendorStringVendorID2.2
idProductStringProductID2.2
iManufacturerString生产商2.2
iProductString设备类型2.2
iSerialString序列号2.2
usbVersionStringUSB版本2.2
attachTypeString加载方式3.6.0
createDateTimestamp创建时间2.2
lastOpDateTimestamp最后一次修改时间2.2
stateUsbDeviceState详情参考state2.2

state

名字类型描述起始版本
nameString资源名称2.2
ordinalint 2.2

SDK示例

Java SDK

QueryUsbDeviceAction action = new QueryUsbDeviceAction();
action.conditions = asList();
action.sessionId = "b51bb939a8844869abb32e9cedbc9a1f";
QueryUsbDeviceAction.Result res = action.call();

Python SDK

QueryUsbDeviceAction action = QueryUsbDeviceAction()
action.conditions = []
action.sessionId = "9f884d4333ba46369cd1039c9ea44965"
QueryUsbDeviceAction.Result res = action.call()