# 获取VNC远程登录地址 - ShowServerRemoteConsole
#### 功能介绍
获取弹性云服务器VNC远程登录地址。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=ECS&api=ShowServerRemoteConsole)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ecs/ecs_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                  | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                             | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| ecs:cloudServers:vnc | read | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | -  | -      |
   
#### URI
POST /v1/{project_id}/cloudservers/{server_id}/remote_console
参数说明请参见[表1]。
 表1参数说明 
| 参数         | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| project_id | 是    | **参数解释：** 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| server_id  | 是    | **参数解释：** 云服务器ID。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                 |
   
#### 请求消息
**请求参数**
请求参数如[表2]所示。
 表2请求参数 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| remote_console | 是    | Object | **参数解释：** 弹性云服务器获取远程登录地址，详情见[表3]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
 表3remote_console参数信息 
| 参数       | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| type     | 是    | String | **参数解释：** 远程登录的类型，请将type配置为"novnc"。 **约束限制：** 不涉及 **取值范围：** novnc **默认取值：** novnc |
| protocol | 是    | String | **参数解释：** 远程登录协议，请将protocol配置为"vnc"。 **约束限制：** 不涉及 **取值范围：** vnc **默认取值：** vnc                                  |
   
#### 响应消息
**响应参数**
响应参数如[表4]所示。
 表4响应参数 
| 参数             | 类型     | 描述                                                                                                                                                                              |
|:---|:---|:---|
| remote_console | Object | **参数解释：** 弹性云服务器获取远程登录地址，详情参见[表5]。 **取值范围：** 不涉及 |
   
 表5remote_console数据结构说明 
| 参数       | 类型     | 描述                                                                                                                                                                                              |
|:---|:---|:---|
| type     | String | **参数解释：** 远程登录的类型。 **取值范围：** novnc                                                                   |
| protocol | String | **参数解释：** 远程登录的协议。 **取值范围：** vnc                                                                       |
| url      | String | **参数解释：** 远程登录的URL。 VNC登录的URL中包含一次性token，请您妥善保管，用完即可丢弃。 **取值范围：** 不涉及 |
   
#### 请求示例
获取ID为"47bc79ae-df61-4ade-9197-283a74e5d70e"的云服务器的VNC远程登录地址。
```
POST https://{endpoint}/v1/13c67a214ced4afb88d911ae4bd5721a/cloudservers/47bc79ae-df61-4ade-9197-283a74e5d70e/remote_console
{
    "remote_console": {
        "protocol": "vnc",
        "type": "novnc"
    }
}
```
#### 响应示例
```
{
   "remote_console": {
        "type": "novnc",
        "protocol": "vnc",
        "url": "https://nova-novncproxy.az1.dc1.domainname.com:8002/vnc_auto.html?token=0fda3eca-8232-4249-****-************&lang=EN&tLength=70"
    }
}
```
#### 返回值
请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。
#### 错误码
请参考[错误码](https://support.huaweicloud.com/api-ecs/ecs_07_0002.html)。