
# 远程登录控制台 - ShowRemoteConsoleAddress
#### 功能介绍
用于直接获取远程登录控制台地址。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ShowRemoteConsoleAddress)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                                                                                                                                                                                            | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:desktops:createConsole | Write | desktop \*  | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId    | -  | -      |
     
  
 
#### URI
GET /v2/{project_id}/desktops/{desktop_id}/remote-consoles
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
| desktop_id | 是    | String | 桌面ID。 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数       | 参数类型   | 描述         |
|:---|:---|:---|
| type     | String | 登录类型。      |
| url      | String | 远程登录控制台地址。 |
| protocol | String | 登录协议。      |
   
**状态码：default**
表3响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
GET /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/2b31e-d520xxxx-xxebedb6-e57xxxxxx/remote-consoles
```
#### 响应示例
**状态码：200**
查询远程登录控制台地址响应体。
```
{
  "type" : "novnc",
  "url" : "https://console.xxx.huawei.com/vnc/xxx/vnc_auto.html?token=803xxxx-704b-4xxx-bbb8-82907cxxx77&lang=EN"
}
```
#### 状态码
| 状态码     | 描述              |
|:---|:---|
| 200     | 查询远程登录控制台地址响应体。 |
| default | 默认错误响应。         |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。
