文档首页/ 弹性云服务器 ECS/ API参考（安卡拉区域）/ API（推荐）/ 状态管理/ 切换弹性云服务器操作系统（未安装Cloud-init）
更新时间：2024-04-16 GMT+08:00
查看PDF

切换弹性云服务器操作系统（未安装Cloud-init）

功能介绍

切换弹性云服务器操作系统。

本接口为异步接口，当前切换弹性云服务器操作系统请求下发成功后会返回job_id，此时切换弹性云服务器操作系统并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUCCESS 时代表云服务器操作系统切换成功。

调用该接口后，系统将卸载系统盘，然后使用新镜像重新创建系统盘，并挂载至弹性云服务器，实现切换操作系统功能。

该接口支持未安装Cloud-init或Cloudbase-init的镜像使用，如果镜像安装了Cloud-init或者Cloudbase-init，请使用 切换弹性云服务器操作系统（安装Cloud-init）接口。

接口约束

  • 不包含系统盘的弹性云服务器不能切换操作系统。
  • 执行切换操作系统任务时，请勿并行执行其他任务，否则可能会引起切换操作系统失败。

URI

POST /v1/{project_id}/cloudservers/{server_id}/changeos

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

project_id

是

项目ID。

获取方法请参见获取项目ID。

server_id

是

弹性云服务器ID。

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

os-change

是

Object

切换弹性云服务器操作系统，详情参见 表3。
表3 os-change字段数据结构说明

参数

是否必选

参数类型

描述

keyname

是

String

密钥名称。

userid

否

String

用户ID。当传入keyname参数时，优先使用本参数设置的userid，若userid为空，默认使用当前token中的userid。

imageid

是

String

切换系统所使用的新镜像的ID，格式为UUID。

镜像的ID可以从控制台或者参考《镜像服务接口参考》的“查询镜像列表”的章节获取。

metadata

否

Object

切换云服务器的元数据。

更多信息，请参见表4。

mode

否

String

取值为withStopServer ，支持开机状态下切换弹性云服务器操作系统。

mode取值为withStopServer时，对开机状态的

弹性云服务器执行切换操作系统操作，系统自动对云服务器先执行关机，再切换操作系统。
表4 metadata字段数据结构说明

参数

是否必选

参数类型

描述

BYOL

否

String

用户是否拥有镜像的license文件。

  • 配置为“true”时，表示镜像使用自带的License文件，即使用BYOL功能。
  • 配置为其他值（即非“true”）时，表示不使用BYOL功能，需使用云平台提供的License文件。

系统默认为非“true”的场景，即不使用BYOL。

响应消息

请参考响应（任务类）。

请求示例

切换云服务器操作系统，切换后采用密钥方式登录鉴权。

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/changeos

{
    "os-change": {
        "keyname": "KeyPair-350b", 
        "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
        "imageid": "e215580f-73ad-429d-b6f2-5433947433b0",
        "mode": "withStopServer"
    }
}

响应示例

请参考响应（任务类）。

{      
    "job_id": "ff80808288d41e1b018990260955686a"
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 状态管理