跳转到主要内容
API Explorer|API Explorer
计算管理/主机相关接口
POSTHost Related Interfaces起始版本 4.7.0同步需要认证

获取主机网页终端链接

获取主机网页终端链接

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • uuidString必填

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

    • httpsBoolean

      暂无描述。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • urlString必填

    主机网页终端链接

  • successboolean必填

    是否成功

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

POST/zstack/v1/hosts/webssh

/zstack/v1/hosts/webssh

操作 ID

GetHostWebSshUrl

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/hosts/webssh' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"uuid":"<uuid>","https":true},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "url": "ws://{{ip}}:8888/ws?id\u003d140147795208568" }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史