弹性云服务器 ECS弹性云服务器 ECS

文档首页> 弹性云服务器 ECS> API参考> API(推荐)> 状态管理> 切换弹性云服务器操作系统(安装Cloud-init)
更新时间:2021/09/18 GMT+08:00
分享

切换弹性云服务器操作系统(安装Cloud-init)

功能介绍

切换弹性云服务器操作系统。支持弹性云服务器数据盘不变的情况下,使用新镜像重装系统盘。

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

接口约束

  • 该接口仅支持安装了Cloud-init或Cloudbase-init的镜像。如果镜像未安装Cloud-init或者Cloudbase-init,请使用 切换弹性云服务器操作系统(未安装Cloud-init)接口。
  • 不包含系统盘的弹性云服务器不能切换操作系统。
  • 执行切换操作系统任务时,请勿并行执行其他任务,否则可能会引起切换操作系统失败。

URI

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

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

参数

是否必选

描述

project_id

项目ID。

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

server_id

弹性云服务器ID。

请求消息

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

参数

是否必选

参数类型

描述

os-change

Object

切换弹性云服务器操作系统,详情参见表3

表3 os-change字段数据结构说明

参数

是否必选

参数类型

描述

adminpass

String

云服务器管理员帐户的初始登录密码。

其中,Windows管理员帐户的用户名为Administrator,Linux管理员账户的用户名为root。

建议密码复杂度如下:

  • 长度为8-26位。
  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?~#*)中的三种。
说明:
  • Windows云服务器的密码,不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。
  • 对于Linux弹性云服务器也可使用user_data字段实现密码注入,此时adminpass字段无效。
  • adminpass和keyname不能同时有值。
  • adminpass和keyname如果同时为空,此时,metadata中的user_data属性必须有值。
  • 对于已安装Cloud-init的云服务器,使用adminpass字段切换操作系统时,系统如果提示您使用keypair方式切换操作系统,表示当前区域暂不支持使用密码方式。

keyname

String

密钥名称。

密钥可以通过密钥创建接口进行创建 创建和导入SSH密钥(请参见),或使用SSH密钥查询接口询已有的密钥(请参见查询SSH密钥列表 )。

userid

String

用户ID。当传入keyname参数时,此参数为必选。

查看用户ID方法:
  1. 登录管理控制台。
  2. 单击用户名,在下拉列表中单击“我的凭证”。在该页面查看用户ID。

imageid

String

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

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

metadata

Object

切换云服务器的元数据。

更多信息,请参见表4

mode

String

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

mode取值为withStopServer时,对开机状态的弹性云服务器执行切换操作系统操作,系统自动对云服务器先执行关机,再切换操作系统。

表4 metadata字段数据结构说明

参数

是否必选

参数类型

描述

user_data

String

创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。

说明:
  • user_data的值为base64编码之后的内容。
  • 注入内容(编码之前的内容)最大长度为32K。

了解更多实例自定义数据注入请参考用户数据注入

示例:

base64编码前:

  • Linux服务器:
    #! /bin/bash
    echo user_test >> /home/user.txt
  • Windows服务器:
    rem cmd
    echo 111 > c:\aaa.txt

base64编码后:

  • Linux服务器:
    IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA==
  • Windows服务器:
    cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0

响应消息

请参考响应(任务类)

请求示例

  • 请求URL示例
    POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos
  • 请求示例1(使用密码方式远程登录重装后的系统)
    {
        "os-change": {
            "adminpass": "1qazXSW@", 
            "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
            "imageid": "e215580f-73ad-429d-b6f2-5433947433b0",
            "mode": "withStopServer"
        }
    }
  • 请求示例2(使用密钥方式远程登录重装后的系统)
    {
        "os-change": {
            "keyname": "KeyPair-350b", 
            "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
            "imageid": "e215580f-73ad-429d-b6f2-5433947433b0"
        }
    }

响应示例

请参考响应(任务类)

返回值

请参考通用请求返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品