跳转到主要内容
API Explorer|API Explorer
系统管理/安全设置相关接口/控制台代理相关接口
POSTConsole Proxy Interfaces起始版本 0.6同步需要认证

请求控制台访问地址

请求控制台访问地址

调试可用性

在线调试

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

请求参数

请求体字段

  • vmInstanceUuidString必填

    虚拟机器UUID。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryConsoleInventory必填

    详情参考inventory

    • schemeString必填

      访问协议类型

    • hostnameString必填

      宿主机名称

    • portint必填

      端口

    • tokenString必填

      口令

请求地址

POST/zstack/v1/consoles

/zstack/v1/consoles

操作 ID

RequestConsoleAccess

永久链接

请求示例

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

响应示例

200
{ "inventory": { "scheme": "http", "hostname": "127.0.0.1", "port": 4900.0, "token": "d96caf24fae54c76b7652f548a258261" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史