Skip to main content
API Explorer|API Explorer
Compute Management/Host Related Interfaces/Set VM USB Redirect Switch(SetVmUsbRedirect)
GETSet VM USB Redirect Switch(SetVmUsbRedirect)Since 2.2SynchronousAuth Required

Query USB Device

Query USB Device

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null when the operation succeeds. See error

    • codeStringRequired

      Error code, a globally unique identifier of the error, e.g. SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause, the source error that caused the current error, null if no original error

  • inventoriesListRequired

    See inventories

    • uuidStringRequired

      UUID of the resource, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Resource description

    • hostUuidStringRequired

      Host UUID

    • vmInstanceUuidStringRequired

      Virtual Machine UUID

    • busNumStringRequired

      Bus number

    • devNumStringRequired

      Device number

    • idVendorStringRequired

      VendorID

    • idProductStringRequired

      ProductID

    • iManufacturerStringRequired

      Manufacturer

    • iProductStringRequired

      Device type

    • iSerialStringRequired

      Serial number

    • usbVersionStringRequired

      USB version

    • attachTypeStringRequired

      Attach method

    • createDateTimestampRequired

      Create date

    • lastOpDateTimestampRequired

      Last update date

    • stateUsbDeviceStateRequired

      See state

      • nameStringRequired

        Resource name

      • ordinalintRequired

        No description provided.

Endpoint

GET/zstack/v1/usb-device/usb-devices

/zstack/v1/usb-device/usb-devices

Operation ID

QueryUsbDevice

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/usb-device/usb-devices' -H 'Authorization: OAuth {sessionUuid}'

Response Example

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

Change History

This API has no change history records yet.

View all change history