跳转到主要内容
API Explorer|API Explorer
计算管理/主机相关接口/USB透传相关接口
GETSet VM USB Redirect Switch(SetVmUsbRedirect)起始版本 2.2同步需要认证

获取USB透传候选列表

获取USB透传候选列表

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

查询参数

请求参数

路径参数

  • vmInstanceUuidString必填

    虚拟机UUID

查询参数

  • attachTypeString

    加载类型

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    成功

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • hostUuidString必填

      主机UUID

    • vmInstanceUuidString必填

      虚拟机UUID

    • busNumString必填

      总线号

    • devNumString必填

      设备号

    • idVendorString必填

      暂无描述。

    • idProductString必填

      产品ID。

    • iManufacturerString必填

      生产商

    • iProductString必填

      设备类型

    • iSerialString必填

      序列号

    • usbVersionString必填

      USB版本

    • attachTypeString必填

      加载方式

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateUsbDeviceState必填

      详情参考state

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

请求地址

GET/zstack/v1/vm-instances/{vmInstanceUuid}/candidate-usb-devices

/zstack/v1/vm-instances/{vmInstanceUuid}/candidate-usb-devices

操作 ID

GetUsbDeviceCandidatesForAttachingVm

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/{vmInstanceUuid}/candidate-usb-devices?attachType=<attachType>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "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" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史