文档首页/ 裸金属服务器 BMS/ API参考/ API/ 裸金属服务器状态管理/ 获取裸金属服务器远程登录地址
更新时间:2024-10-22 GMT+08:00

获取裸金属服务器远程登录地址

功能介绍

获取裸金属服务器远程登录地址。

约束

Windows系统的裸金属服务器不支持远程登录。

URI

POST /v1/{project_id}/baremetalservers/{server_id}/remote_console

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方式请参见获取项目ID

server_id

裸金属服务器ID。

可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(废弃)获取。

请求参数

参数

是否必选

参数类型

描述

remote_console

Object

标记为获取裸金属服务器远程登录地址。详情请参见表2

表2 remote_console字段数据结构说明

参数

是否必选

参数类型

描述

protocol

String

远程登录协议,请将protocol配置为“serial”。

type

String

远程登录的类型,请将type配置为“serial”。

请求示例

获取ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器的远程登录地址,远程登录协议和类型均为serial。
1
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/remote_console
{
    "remote_console": {
        "protocol": "serial",
        "type": "serial"
    }
}

响应参数

参数

参数类型

描述

remote_console

Object

裸金属服务器获取远程登录地址。详情请参见表3

表3 remote_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

服务器已成功处理了请求。

其他返回值请参考状态码

错误码

请参考错误码