切换弹性云服务器操作系统(安装Cloud-init)
功能介绍
切换弹性云服务器操作系统。支持弹性云服务器数据盘不变的情况下,使用新镜像重装系统盘。
本接口为异步接口,当前切换弹性云服务器操作系统请求下发成功后会返回job_id,此时切换弹性云服务器操作系统并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUCCESS 时代表云服务器操作系统切换成功。
调用该接口后,系统将卸载系统盘,然后使用新镜像重新创建系统盘,并挂载至弹性云服务器,实现切换操作系统功能。
接口约束
- 该接口仅支持安装了Cloud-init或Cloudbase-init的镜像。如果镜像未安装Cloud-init或者Cloudbase-init,请使用 切换弹性云服务器操作系统(未安装Cloud-init)接口。
- 不包含系统盘的弹性云服务器不能切换操作系统。
- 执行切换操作系统任务时,请勿并行执行其他任务,否则可能会引起切换操作系统失败。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/cloudservers/{server_id}/changeos
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
adminpass |
否 |
String |
云服务器管理员账户的初始登录密码。 其中,Windows管理员账户的用户名为Administrator,Linux管理员账户的用户名为root。 建议密码复杂度如下:
说明:
|
keyname |
否 |
String |
密钥名称。 密钥可以通过密钥创建接口进行创建 创建和导入SSH密钥(请参见),或使用SSH密钥查询接口查询已有的密钥(请参见查询SSH密钥列表 )。 |
userid |
否 |
String |
用户ID。当传入keyname参数时,优先使用本参数设置的userid,若userid为空,默认使用当前token中的userid。
查看用户ID方法:
|
imageid |
是 |
String |
切换系统所使用的新镜像的ID,格式为UUID。 镜像的ID可以从控制台或者参考《镜像服务API参考》的“查询镜像列表”的章节获取。 |
isAutoPay |
否 |
String |
下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付。
说明:
适用于包年/包月虚拟机费用发生变化时,不传该字段时默认为客户手动支付。 |
metadata |
否 |
Object |
切换云服务器的元数据。 更多信息,请参见表4。 |
mode |
否 |
String |
取值为withStopServer ,支持开机状态下切换弹性云服务器操作系统。 mode取值为withStopServer时,对开机状态的弹性云服务器执行切换操作系统操作,系统自动对云服务器先执行关机,再切换操作系统。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
user_data |
否 |
String |
创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。
说明:
了解更多实例自定义数据注入请参考用户数据注入。 示例: base64编码前:
base64编码后:
|
__system__encrypted |
否 |
String |
metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,系统盘默认为不加密。 |
__system__cmkid |
否 |
String |
用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。
说明:
请参考查询密钥列表,通过HTTPS请求获取密钥ID。 |
响应消息
请参考响应(任务类)。
请求示例
- 切换云服务器操作系统,切换后采用密码方式登录鉴权,建议将密码在配置文件或者环境变量中密文存放,使用时解密,确保安全。
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos { "os-change": { "adminpass": "$ADMIN_PASS", "userid": "7e25b1da389f4697a79df3a0e5bd494e", "imageid": "e215580f-73ad-429d-b6f2-5433947433b0", "mode": "withStopServer" } }
- 切换云服务器操作系统,切换后采用密钥方式登录鉴权。
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos { "os-change": { "keyname": "KeyPair-350b", "userid": "7e25b1da389f4697a79df3a0e5bd494e", "imageid": "e215580f-73ad-429d-b6f2-5433947433b0" } }
- 使用系统盘加密的整机镜像切换云服务器的操作系统,切换后使用密码方式登录鉴权,建议将密码在配置文件或者环境变量中密文存放,使用时解密,确保安全。
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos { "os-change": { "adminpass": "$ADMIN_PASS", "userid": "7e25b1da389f4697a79df3a0e5bd494e", "imageid": "e215580f-73ad-429d-b6f2-5433947433b0", "metadata": { "__system__encrypted": "1", "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846" } } }
返回值
请参考通用请求返回值。
错误码
请参考错误码。