# 获取裸金属服务器远程登录地址 - ShowServerRemoteConsole
#### 功能介绍
获取裸金属服务器远程登录地址。
#### 约束
Windows系统的裸金属服务器不支持远程登录。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/BMS/doc?api=ShowServerRemoteConsole)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-bms/bms_api_0900.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                       | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | bms:servers:serialConsole | read | instance\*  | - g:EnterpriseProjectId  - g:ResourceTag/\<tag-key\>   | -  | -      |
     
  
 
#### URI
POST /v1/{project_id}/baremetalservers/{server_id}/remote_console
参数说明请参见[表1]。
 表1参数说明 
| 参数         | 是否必选 | 描述                                                                                                                                             |
|:---|:---|:---|
| project_id | 是    | 项目ID。 获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-bms/bms_api_appendix_03.html)。                        |
| server_id  | 是    | 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用[查询裸金属服务器列表（废弃）](https://support.huaweicloud.com/api-bms/bms_api_0709.html)获取。 |
   
#### 请求参数
| 参数             | 是否必选 | 参数类型   | 描述                                                              |
|:---|:---|:---|:---|
| remote_console | 是    | Object | 标记为获取裸金属服务器远程登录地址。详情请参见[表2]。 |
   
 表2remote_console字段数据结构说明 
| 参数       | 是否必选 | 参数类型   | 描述                            |
|:---|:---|:---|:---|
| protocol | 是    | String | 远程登录协议，请将protocol配置为"serial"。 |
| type     | 是    | String | 远程登录的类型，请将type配置为"serial"。    |
   
#### 请求示例
获取ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器的远程登录地址，远程登录协议和类型均为serial。
```
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/remote_console
```
```
{
    "remote_console": {
        "protocol": "serial",
        "type": "serial"
    }
}
```
#### 响应参数
| 参数             | 参数类型   | 描述                                                          |
|:---|:---|:---|
| remote_console | Object | 裸金属服务器获取远程登录地址。详情请参见[表3]。 |
   
 表3remote_console字段数据结构说明 
| 参数       | 参数类型   | 描述        |
|:---|:---|:---|
| type     | String | 远程登录的类型。  |
| protocol | String | 远程登录的协议。  |
| url      | String | 远程登录的url。 |
   
#### 响应示例
```
{
   "remote_console": {
        "type": "serial",
        "protocol": "serial",
        "url": "https://console.domainname.com:443/serial/pod05ironic.region-01/?token=2a794f06-15ec-4f3d-a55b-06aca8e3dcbc"
    }
}
```
#### 返回值
正常返回值：
| 返回值 | 说明           |
|:---|:---|
| 200 | 服务器已成功处理了请求。 |
   
其他返回值请参考[状态码](https://support.huaweicloud.com/api-bms/bms_api_0801.html)。
#### 错误码
请参考[错误码](https://support.huaweicloud.com/api-bms/bms_api_0802.html)。