文档首页/ 弹性云服务器 ECS/ API参考/ API/ 状态管理/ 重装弹性云服务器操作系统（未安装Cloud-init）
更新时间：2024-11-14 GMT+08:00
查看PDF
分享

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

功能介绍

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

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

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

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

接口约束

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

调试

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

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密钥查询接口查询已有的密钥（请参见查询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" 
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 状态管理

相关文档