/ 弹性云服务器 ecs/ api参考/ api/ 状态管理/ 重装弹性云服务器操作系统(未安装cloud-init)
更新时间:2024-11-14 gmt 08:00

重装弹性云服务器操作系统(未安装cloud-九游平台

功能介绍

重装弹性云服务器的操作系统。

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

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

该接口支持未安装cloud-init或cloudbase-init的镜像,如果镜像安装了cloud-init或者cloudbase-init,请使用 重装弹性云服务器操作系统(安装cloud-init)接口。

接口约束

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

调试

您可以在中调试该接口。

uri

post /v1/{project_id}/cloudservers/{server_id}/reinstallos

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

参数

是否必选

描述

project_id

项目id。

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

server_id

弹性云服务器id。

请求消息

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

参数

是否必选

参数类型

描述

os-reinstall

object

重装弹性云服务器,详情参见表3

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

参数

是否必选

参数类型

描述

adminpass

string

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

其中,windows管理员账户的用户名为administrator,linux管理员账户的用户名为root。

建议密码复杂度如下:

  • 长度为8-26位。
  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_= [{}]:,./?~#*)中的三种。
说明:
  • 对于windows弹性云服务器,仅支持密码方式,且密码不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。
  • adminpass和keyname不能同时为空。
  • adminpass和keyname不能同时有值。

keyname

string

密钥名称。

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

userid

string

用户id。

metadata

object

重装云服务器的元数据。

更多信息,请参见表4

mode

string

取值为withstopserver ,支持开机状态下重装弹性云服务器

mode取值为withstopserver时,对开机状态的

弹性云服务器执行重装操作,系统自动对云服务器先执行关机,再重装操作系统。

表4 metadata字段数据结构说明

参数

是否必选

参数类型

描述

__system__encrypted

string

metadata中的表示加密功能的字段,0代表不加密,1代表加密。

该字段不存在时,系统盘默认为不加密。

__system__cmkid

string

用户主密钥id,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。

说明:

请参考,通过https请求获取密钥id。

响应消息

请参考。

请求示例

重装云服务器操作系统,重装后采用密钥方式登录鉴权。

post https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/reinstallos
{
    "os-reinstall": {
        "keyname": "keypair-350b", 
        "userid": "7e25b1da389f4697a79df3a0e5bd494e",
        "metadata": {
              "__system__encrypted": "1",
              "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846"
        }
    }
}

响应示例

请参考。

{      
    "job_id": "ff80808288d41e1b018990260955686a" 
}

返回值

请参考通用请求返回值

错误码

请参考。

相关文档

网站地图