更新时间:2024-09-05 GMT+08:00
分享

获取VNC远程登录地址

功能介绍

获取VNC远程登录地址。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/app-servers/{server_id}/actions/vnc

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目唯一标识。

server_id

String

服务器唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

type

String

登录类型:

  • novnc

  • vnc

url

String

远程登录控制台地址。

protocol

String

登录协议。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

GET /v1/26a0420e9e284569a23f1b2f7d9b5011/app-servers/wksapp-12f749da-3d84-4f2c-99c9-9bd1bfdc8cf0/actions/vnc

响应示例

状态码: 200

成功响应。

{
  "url" : "https://cn-north-5-conso*******_auto.html?token=58843dfe-4e75-******dc2c42&lang=EN",
  "type" : "novnc"
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码

相关文档