设置云服务器串口登录 - UpdateSerialConsoleOptions

功能介绍

设置云服务器串口登录。

接口约束

该接口仅在“非洲-开罗”、“”非洲-约翰内斯堡”和“中东-利雅得”区域支持，其他区域暂不支持。
重启云服务器后，该设置才会生效。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v1/{project_id}/cloudservers/{server_id}/serial-console-options

参数说明请参见表1。

表1 参数说明
参数	是否必选	描述
project_id	是	参数解释：项目ID。获取方法请参见获取项目ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及
server_id	是	参数解释：云服务器ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求消息

请求参数如表2所示。

表2 请求参数
参数	是否必选	参数类型	描述
serial_console_options	否	Object	参数解释：设置弹性云服务器串口登录，请参见表3。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表3 serial_console_options数据结构说明
参数	是否必选	参数类型	描述
enabled	否	Boolean	参数解释：弹性云服务器是否支持串口登录。约束限制：不涉及取值范围： true：支持串口登录。 false：不支持串口登录。默认取值： false

响应消息

无

请求示例

PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/serial-console-options

{
    "serial_console_options": {
        "enabled": true
    }
}