跳转到主要内容
API Explorer|API Explorer
计算管理/主机相关接口/USB重定向相关接口
GETUSB Redirect Related Interfaces起始版本 2.1同步需要认证

获取虚拟机USB重定向开关状态

获取虚拟机USB重定向开关状态

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • uuidString必填

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

查询参数

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • enableboolean必填

    usb redirect 开关是否开启

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

GET/zstack/v1/vm-instances/{uuid}/usbredirect

/zstack/v1/vm-instances/{uuid}/usbredirect

操作 ID

GetVmUsbRedirect

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/{uuid}/usbredirect?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "enable": true }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史