文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›开发手册ZCF
文档目录

USB透传相关接口

云主机加载物理机USB设备(AttachUsbDeviceToVm)

API请求

URLs
POST zstack/v1/usb-device/usb-devices/{usbDeviceUuid}/attach
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "vmInstanceUuid": "2a3697245a4a3e829a246e222c243688",
    "attachType": "PassThrough"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"vmInstanceUuid":"2a3697245a4a3e829a246e222c243688","attachType":"PassThrough"}}' http://localhost:8080/zstack/v1/usb-device/usb-devices/84838a1925bb3eb3b2440a8afd420e40/attach
参数列表
名字 类型 位置 描述 可选值 起始版本
usbDeviceUuid String url USB设备UUID 2.2
vmInstanceUuid String body(包含在params结构中) 云主机UUID 2.2
attachType (可选) String body(包含在params结构中) 加载类型
  • PassThrough
  • Redirect
 3.5.0
systemTags (可选) List body 系统标签 2.2
userTags (可选) List body 用户标签 2.2

API返回

返回示例

{
  "inventory": {
    "uuid": "dc782167a4853525848fd04bf606d072",
    "name": "usb",
    "hostUuid": "dea6020aae7b3244be45eee6ae1d4d0f",
    "vmInstanceUuid": "33471e0ae8a33b3b8b0f295eff6e4db4",
    "state": "Enabled",
    "busNum": "001",
    "devNum": "001",
    "idVendor": "0781",
    "idProduct": "5591",
    "iManufacturer": "SanDisk",
    "iProduct": "Ultra USB 3.0",
    "iSerial": "000000000001",
    "usbVersion": "3.0",
    "attachType": "PassThrough"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.2
inventory UsbDeviceInventory 详情参考inventory 2.2
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.2
description String 错误的概要描述 2.2
details String 错误的详细信息 2.2
elaboration String 保留字段，默认为null 2.2
opaque LinkedHashMap 保留字段，默认为null 2.2
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.2
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.2
name String 资源名称 2.2
description String 资源的详细描述 2.2
hostUuid String 物理机UUID 2.2
vmInstanceUuid String 云主机UUID 2.2
busNum String 总线号 2.2
devNum String 设备号 2.2
idVendor String VendorID 2.2
idProduct String ProductID 2.2
iManufacturer String 生产商 2.2
iProduct String 设备类型 2.2
iSerial String 序列号 2.2
usbVersion String USB版本 2.2
attachType String 加载方式 3.5.0
createDate Timestamp 创建时间 2.2
lastOpDate Timestamp 最后一次修改时间 2.2
state UsbDeviceState 详情参考state 2.2
#state
名字 类型 描述 起始版本
name String 资源名称 2.2
ordinal int 2.2

SDK示例

Java SDK
AttachUsbDeviceToVmAction action = new AttachUsbDeviceToVmAction();
action.usbDeviceUuid = "84838a1925bb3eb3b2440a8afd420e40";
action.vmInstanceUuid = "2a3697245a4a3e829a246e222c243688";
action.attachType = "PassThrough";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachUsbDeviceToVmAction.Result res = action.call();
Python SDK
AttachUsbDeviceToVmAction action = AttachUsbDeviceToVmAction()
action.usbDeviceUuid = "84838a1925bb3eb3b2440a8afd420e40"
action.vmInstanceUuid = "2a3697245a4a3e829a246e222c243688"
action.attachType = "PassThrough"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachUsbDeviceToVmAction.Result res = action.call()

将云主机挂载的USB设备卸载(DetachUsbDeviceFromVm)

API请求

URLs
POST zstack/v1/usb-device/usb-devices/{usbDeviceUuid}/detach
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' \
http://localhost:8080/zstack/v1/usb-device/usb-devices/17a5e98e5f943e8fafa01602d50cf3ad/detach
参数列表
名字 类型 位置 描述 可选值 起始版本
usbDeviceUuid String url USB设备UUID 2.2
systemTags (可选) List body 系统标签 2.2
userTags (可选) List body 用户标签 2.2

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
    }
}

SDK示例

Java SDK
DetachUsbDeviceFromVmAction action = new DetachUsbDeviceFromVmAction();
action.usbDeviceUuid = "5256c889e9f0489e8fd12b66d176fb7d";
action.sessionId = "8082962f2d304a3fbee969e6b4749338";
DetachUsbDeviceFromVmAction.Result res = action.call();
Python SDK
DetachUsbDeviceFromVmAction action = DetachUsbDeviceFromVmAction()
action.usbDeviceUuid = "ced1bbb139c54d1d973ddc38ae565244"
action.sessionId = "f6550a168b9847fca4c98df088d86c09"
DetachUsbDeviceFromVmAction.Result res = action.call()

获取USB透传候选列表(GetUsbDeviceCandidatesForAttachingVm)

API请求

URLs
GET zstack/v1/vm-instances/{vmInstanceUuid}/candidate-usb-devices
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/vm-instances/ab759c79169739cb9e13ff091c4fa386/candidate-usb-devices?attachType=PassThrough
参数列表
名字 类型 位置 描述 可选值 起始版本
vmInstanceUuid String url 云主机UUID 2.2
attachType (可选) String query 加载类型
  • PassThrough
  • Redirect
 3.6.0
systemTags (可选) List query 系统标签 2.2
userTags (可选) List query 用户标签 2.2

API返回

返回示例
{
  "inventories": [
    {
      "uuid": "b58b4b48b3b8398f93b8b529f6f5b53a",
      "name": "usb",
      "hostUuid": "9f7438cf6fd233cf8fc27d4f311326ca",
      "vmInstanceUuid": "ccdfb1d443433e1a8beac3a1d54374d5",
      "state": "Enabled",
      "busNum": "001",
      "devNum": "001",
      "idVendor": "0781",
      "idProduct": "5591",
      "iManufacturer": "SanDisk",
      "iProduct": "Ultra USB 3.0",
      "iSerial": "000000000001",
      "usbVersion": "3.0",
      "attachType": "PassThrough"
    }
  ]
}
名字 类型 描述 起始版本
success boolean 成功 2.2
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.2
inventories List 详情参考inventories 2.2
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.2
description String 错误的概要描述 2.2
details String 错误的详细信息 2.2
elaboration String 保留字段，默认为null 2.2
opaque LinkedHashMap 保留字段，默认为null 2.2
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.2
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.2
name String 资源名称 2.2
description String 资源的详细描述 2.2
hostUuid String 物理机UUID 2.2
vmInstanceUuid String 云主机UUID 2.2
busNum String 总线号 2.2
devNum String 设备号 2.2
idVendor String VendorID 2.2
idProduct String ProductID 2.2
iManufacturer String 生产商 2.2
iProduct String 设备类型 2.2
iSerial String 序列号 2.2
usbVersion String USB版本 2.2
attachType String 加载方式 3.5.0
createDate Timestamp 创建时间 2.2
lastOpDate Timestamp 最后一次修改时间 2.2
state UsbDeviceState 详情参考state 2.2
#state
名字 类型 描述 起始版本
name String 资源名称 2.2
ordinal int 2.2

SDK示例

Java SDK
GetUsbDeviceCandidatesForAttachingVmAction action = new GetUsbDeviceCandidatesForAttachingVmAction();
action.vmInstanceUuid = "ab759c79169739cb9e13ff091c4fa386";
action.attachType = "PassThrough";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetUsbDeviceCandidatesForAttachingVmAction.Result res = action.call();
Python SDK
GetUsbDeviceCandidatesForAttachingVmAction action = GetUsbDeviceCandidatesForAttachingVmAction()
action.vmInstanceUuid = "ab759c79169739cb9e13ff091c4fa386"
action.attachType = "PassThrough"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetUsbDeviceCandidatesForAttachingVmAction.Result res = action.call()

查询USB设备(QueryUsbDevice)

API请求

URLs
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"
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.2
inventories List 详情参inventories 2.2
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.2
description String 错误的概要描述 2.2
details String 错误的详细信息 2.2
elaboration String 保留字段，默认为null 2.2
opaque LinkedHashMap 保留字段，默认为null 2.2
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.2
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.2
name String 资源名称 2.2
description String 资源的详细描述 2.2
hostUuid String 物理机UUID 2.2
vmInstanceUuid String 云主机UUID 2.2
busNum String 总线号 2.2
devNum String 设备号 2.2
idVendor String VendorID 2.2
idProduct String ProductID 2.2
iManufacturer String 生产商 2.2
iProduct String 设备类型 2.2
iSerial String 序列号 2.2
usbVersion String USB版本 2.2
attachType String 加载方式 3.6.0
createDate Timestamp 创建时间 2.2
lastOpDate Timestamp 最后一次修改时间 2.2
state UsbDeviceState 详情参考state 2.2
#state
名字 类型 描述 起始版本
name String 资源名称 2.2
ordinal int 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()

更新USB设备(UpdateUsbDevice)

API请求

URLs
PUT zstack/v1/usb-device/usb-devices/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateUsbDevice": {
    "name": "usb",
    "description": "this is a usb device",
    "state": "Enabled"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateUsbDevice":{"name":"usb","description":"this is a usb device","state":"Enabled"}}' \
http://localhost:8080/zstack/v1/usb-device/usb-devices/9d1ab4950ce933edabbaf8e73ca7e879/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 2.2
name (可选) String body(包含在updateUsbDevice结构中) 资源名称 2.2
description (可选) String body(包含在updateUsbDevice结构中) 资源的详细描述 2.2
state (可选) String body(包含在updateUsbDevice结构中) USB设备状态
  • Enabled
  • Disabled
 2.2
systemTags (可选) List body 系统标签 2.2
userTags (可选) List body 用户标签 2.2

API返回

返回示例
{
  "inventory": {
    "uuid": "2695f7ce0bda4587bbabbbfaad080554",
    "description": "test usb",
    "hostUuid": "4261ceb358ce473fa62c137c1ba8d3ef",
    "vmInstanceUuid": "4c059c5e0a834d86984d3141d8ec42cb",
    "state": "Disabled",
    "idVendor": "10de",
    "idProduct": "0e0f",
    "iManufacturer": "SanDisk",
    "iProduct": "USB Storage",
    "iSerial": "000000000001",
    "usbVersion": "3.0",
    "attachType": "PassThrough"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 2.2
inventory UsbDeviceInventory 详情参考inventory 2.2
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 2.2
description String 错误的概要描述 2.2
details String 错误的详细信息 2.2
elaboration String 保留字段，默认为null 2.2
opaque LinkedHashMap 保留字段，默认为null 2.2
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 2.2
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 2.2
name String 资源名称 2.2
description String 资源的详细描述 2.2
hostUuid String 物理机UUID 2.2
vmInstanceUuid String 云主机UUID 2.2
busNum String 总线号 2.2
devNum String 设备号 2.2
idVendor String VendorID 2.2
idProduct String ProductID 2.2
iManufacturer String 生产商 2.2
iProduct String 设备类型 2.2
iSerial String 序列号 2.2
usbVersion String USB版本 2.2
attachType String 加载方式 3.6.0
createDate Timestamp 创建时间 2.2
lastOpDate Timestamp 最后一次修改时间 2.2
state UsbDeviceState 详情参考state 2.2
#state
名字 类型 描述 起始版本
name String 资源名称 2.2
ordinal int 2.2

SDK示例

Java SDK
UpdateUsbDeviceAction action = new UpdateUsbDeviceAction();
action.uuid = "86d05b807cfa47a7969745f0ffe8ee4b";
action.name = "usb";
action.description = "this is a usb device";
action.state = "Enabled";
action.sessionId = "86600ceaed5642ad810828129fe0e4a0";
UpdateUsbDeviceAction.Result res = action.call();
Python SDK
UpdateUsbDeviceAction action = UpdateUsbDeviceAction()
action.uuid = "f16940abc205404bb17b00367f5b6a8d"
action.name = "usb"
action.description = "this is a usb device"
action.state = "Enabled"
action.sessionId = "a65b10bd9a164d33a42d8bacfab5acd6"
UpdateUsbDeviceAction.Result res = action.call()
上一篇USB重定向相关接口下一篇SR-IOV相关接口
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心